You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/关注主播接口
关注主播接口
最近更新时间：2023.09.22 17:59:57首次发布时间：2022.08.12 10:52:49
我的收藏

企业直播支持与您的系统对接，实现观众关注主播或者取消关注主播的操作。本文介绍您需要自行开发的接口的相关规范，请按照规范完成接口的开发。

说明

如果在对接过程中遇到问题，请联系客户经理或技术支持。

背景信息

观众可以在观看页关注主播或者取消关注主播。为实现该功能，您需要开发以下两个接口并在直播间的营销互动 > 营销广告页面的账号库管理对话框中进行以下接口配置。更多有关关注主播的功能介绍，详见关联主播账号。
图片

获取用户是否关注主播接口

  • 接口说明：企业直播可通过调用该接口，从您的自有账号系统中获取用户对主播账号的关注状态，并将关注状态以及主播账号的粉丝数从自有账号系统同步至企业直播。
  • 请求方式：GET

请求参数

Query

参数名

类型

是否必选

描述

ExternalId

String

是

您自有账号系统的用户 ID。

ExternalName

String

是

您自有账号系统的用户名称。

Ts

Integer

是

接口调用时，系统时间的 Unix 秒级时间戳。

ActivityId

Integer

是

直播间的活动 ID。

HostAccountId

String

是

主播账号 ID。

HostAccountName

String

是

主播账号名称。

Sign

String

是

校验值。
该参数值获取方法如下：

  1. 将以上所有参数和参数值基于参数名称按字典序排列。

  2. 按照参数名称参数值参数名称参数值的格式进行拼接。

  3. 首尾加上 accountSecret 的值。联系技术支持获取 accountSecret 的值。

  4. 将字符串进行 MD5 加密并转化为 32 位小写密文。
    例如：

    {
"ExternalId": "8erwwdfthf6e****",
"ExternalName": "UserA",
"Ts": 1650778541,
"ActivityId": 172982551195****,
"HostAccountId": "abc1",
"HostAccountName": "HostA"
}

    accountSecret 的值为 abc，则拼接后的字符串为 abcActivityId172982551195****ExternalId8erwwdfthf6e****ExternalNameUserAHostAccountIdabc1HostAccountNameHostATs1650778541abc，将字符串进行 MD5 加密并转化为 32 位小写密文，Sign 的值为 51120a92e23358902d52ed57c9eb****。

返回参数

参数名

类型

描述

Code

Integer

HTTP 状态码。

Status

Integer

用户对主播账号的关注状态。

  • 0：未关注。
  • 1：已关注。
  • 2：错误状态。

Message

String

当 Status 的值为 2 时，返回的错误信息。

Number

Integer

当前主播账号的粉丝数。

示例

请求示例

GET https://test.com/get?ExternalId=8erwwdfthf6e****&ExternalName=UserA&Ts=1650778541&ActivityId=172982551195****&HostAccountId=abc1&HostAccountName=HostA&Sign=51120a92e23358902d52ed57c9eb****

返回示例

{
    "Code": 200,
    "Status": 0,
    "Message": "",
    "Number": 123
}

更新用户关注主播接口

  • 接口说明：企业直播可通过调用该接口，将用户对主播账号的关注状态从企业直播同步更新至您的自有账号系统。
  • 请求方式：POST

请求参数

Query

参数名

类型

是否必选

描述

ExternalId

String

是

您自有账号系统的用户 ID。

ExternalName

String

是

您自有账号系统的用户名称。

Ts

Integer

是

接口调用时，系统时间的 Unix 秒级时间戳。

ActivityId

Integer

是

直播间的活动 ID。

HostAccountId

String

是

主播账号 ID。

HostAccountName

String

是

主播账号名称。

Status

Integer

是

用户对主播账号的关注状态。

  • 0：未关注。
  • 1：已关注。

Sign

String

是

校验值。
该参数值获取方法如下：

  1. 将以上所有参数和参数值基于参数名称按字典序排列。

  2. 按照参数名称参数值参数名称参数值的格式进行拼接。

  3. 首尾加上 accountSecret 的值。联系技术支持获取 accountSecret 的值。

  4. 将字符串进行 MD5 加密并转化为 32 位小写密文。
    例如：

    {
"ExternalId": "8erwwdfthf6e****",
"ExternalName": "UserA",
"Ts": 1650778541,
"ActivityId": 172982551195****,
"HostAccountId": "abc1",
"HostAccountName": "HostA",
"Status": 1
}

    accountSecret 的值为 abc，则拼接后的字符串为 abcActivityId172982551195****ExternalId8erwwdfthf6e****ExternalNameUserAHostAccountIdabc1HostAccountNameHostAStatus1Ts1650778541abc，将字符串进行 MD5 加密并转化为 32 位小写密文，Sign 的值为 2d003267b69e5f0f3ed2a57de2a1****。

返回参数

参数名

类型

描述

Code

Integer

HTTP 状态码。

Status

Integer

用户对主播账号的关注状态。

  • 0：未关注。
  • 1：已关注。
  • 2：错误状态。

Message

String

当 Status 的值为 2 时，返回的错误信息。

Number

Integer

当前主播账号的粉丝数。

示例

请求示例

POST https://test.com/get?ExternalId=8erwwdfthf6e****&ExternalName=UserA&Ts=1650778541&ActivityId=172982551195****&HostAccountId=abc1&HostAccountName=HostA&Status=1&Sign=2d003267b69e5f0f3ed2a57de2a1****

返回示例

{
    "Code": 200, 
    "Status": 0, 
    "Message": "", 
    "Number": 123
}