You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
企业直播
自有账号系统积分接口
复制全文
下载 pdf
自有账号系统积分接口

企业直播支持与您的积分系统对接,实现观众兑换积分礼物打赏主播的操作。本文介绍您需要自行开发的接口的相关规范,请按照规范完成接口的开发。

说明

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

背景信息

观众可以消耗积分兑换礼物,对主播实时进行打赏。为实现该功能,您需要开发以下两个接口,并在直播间的营销互动 > 礼物打赏页面选择积分消费方式后完成以下接口配置。更多有关积分礼物打赏的功能介绍,详见礼物打赏。
Image

积分查询接口

  • 接口说明:企业直播可通过调用该接口,从您的自有账号系统中获取观众的剩余积分,并在企业直播观看页上同步展示。
  • 请求方式:GET

请求参数

Query 参数

参数

类型

是否必选

描述

UserId

String

是

观众在您自有账号系统中的用户 ID。

UserName

String

是

观众在您自有账号系统中的用户名称。

Ts

Integer

是

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

ActivityId

Integer

是

直播间的活动 ID。

Sign

String

是

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

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

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

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

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

    {
    "UserId": "8erwwdfthf6e****",
    "UserName": "UserA",
    "Ts": 1650778541,
    "ActivityId": 172982551195***
    }
    

    accountSecret的值为abc,则拼接后的字符串为abcActivityId172982551195****Ts1650778541UserId8erwwdfthf6e****UserNameUserAabc,将字符串进行 MD5 加密并转化为 32 位小写密文,Sign 的值为 2625701639ccf0081d3862ab6815****。

返回参数

Body 参数

参数

类型

是否必选

描述

Code

Integer

是

HTTP 状态码。

Status

Integer

是

服务状态。

  • 0:成功
  • 1:积分不足
  • 2:其他错误

Message

String

是

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

Data

Integer

是

观众的剩余积分。

示例

请求示例

GET https://test.com/get?UserId=8erwwdfthf6e****&UserName=UserA&Ts=1650778541&ActivityId=172982551195****&Sign=2625701639ccf0081d3862ab6815****

返回示例

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

积分更新接口

  • 接口说明:
    • 企业直播可通过调用该接口,将观众兑换礼物消耗的积分从企业直播同步更新至您的自有账号系统中。
    • 企业直播调用该接口的频率上限为:账号整体不超过 50 次/秒,同一观众不超过 5 次/秒。
    • 如果您希望企业直播在调用失败后自动重试,请先确保您的积分更新接口支持按 TransactionId 幂等处理,避免因重试导致重复扣除积分。企业直播在同一次后端 HTTP 重试中,会复用完全相同的 TransactionId、Ts、Sign 和 Body。
  • 请求方式:POST

请求参数

Body 参数

参数

类型

是否必选

描述

UserId

String

是

观众在您自有账号系统中的用户 ID。

UserName

String

是

观众在您自有账号系统中的用户名称。

Ts

Integer

是

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

GiftName

String

是

积分兑换的礼物名称。

GiftPrice

Integer

是

积分兑换的礼物价格。

GiftCount

Integer

是

积分兑换的礼物数量。

Amount

Integer

是

总共兑换的积分。

ActivityId

Integer

是

直播间的活动 ID。

TransactionId

String

是

企业直播生成的积分礼物交易标识。您可记录该参数并按该参数做幂等处理,用于避免重复扣除积分及后续对账。该参数不参与 Sign 计算。

Sign

String

是

校验值。
计算 Sign 时,TransactionId 不参与签名。计算方法如下:

  1. 将 UserId、UserName、Ts、GiftName、GiftPrice、GiftCount、Amount 和 ActivityId 的参数名称和参数值基于参数名称按字典序排列。

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

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

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

    {
    "UserId": "8erwwdfthf6e****",
    "UserName": "UserA",
    "Ts": 1650778541,
    "GiftName": "小心心",
    "GiftPrice": 1,
    "GiftCount": 100,
    "Amount": 100,
    "ActivityId": 172982551195****,
    "TransactionId": "Qx8M5J9Y7nR3vW1kL2pA6cD0eF4gH8iK9mN1sT5uV7w"
    }
    

    accountSecret的值为abc,则拼接后的字符串为abcActivityId172982551195****Amount100GiftCount100GiftName小心心GiftPrice1Ts1650778541UserId8erwwdfthf6e****UserNameUserAabc,将字符串进行 MD5 加密并转化为 32 位小写密文,Sign 的值为3d3436e952701b7cbb72853e709b****。

返回参数

Body 参数

参数

类型

是否必选

描述

Code

Integer

是

HTTP 状态码。

Status

Integer

是

服务状态。

  • 0:成功
  • 1:积分不足
  • 2:其他错误

Message

String

是

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

Data

Integer

是

观众的剩余积分。

示例

请求示例

POST https://test.com/post
            header Content-Type: application/json; charset=utf-8
            body {
                 "UserId": "8erwwdfthf6e****",
                 "UserName": "UserA",
                 "Ts": 1650778541,
                 "GiftName": "小心心",
                 "GiftPrice": 1,
                 "GiftCount": 100,
                 "Amount": 100,
                 "ActivityId": 172982551195****,
                 "TransactionId": "Qx8M5J9Y7nR3vW1kL2pA6cD0eF4gH8iK9mN1sT5uV7w",
                 "Sign": "3d3436e952701b7cbb72853e709b****"
                 }

返回示例

{
       "Code": 200, 
       "Status": 0, 
       "Message": "", 
       "Data": 123 
   }
最近更新时间:2026.10.20 12:00:00
这个页面对您有帮助吗?
有用
有用
无用
无用