You need to enable JavaScript to run this app.
导航
直播预约结果回调
最近更新时间:2025.03.21 10:45:22首次发布时间:2022.11.22 11:12:49
我的收藏
有用
有用
无用
无用

作用

当到达直播预约的短信提醒时间时,企业直播会对所设置的接口地址进行回调通知。

配置方式

将接收回调通知的接口地址提供给企业直播技术支持。

详情

设置回调的接口地址后,当到达直播预约的短信提醒时间时,企业直播会将预约的用户信息和直播间信息以 POST 方式提交给您自定义的回调接口地址。例如,直播间开播时间为 19:00,配置的短信提醒时间为开播前 5 分钟,则企业直播将在 18:55 发送回调消息。有关如何配置直播预约的短信提醒时间,详见直播预约。单次回调最多包含 2000 条预约用户信息,若预约用户信息超过该上限,企业直播将分多次发送回调消息。
请求示例如下所示:

POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
    "AccountID": "20000****",
    "ActivityID": "182573526550****",
    "ActivityName": "直播间 A",
    "EventType": "ActivityReservationInfoCallBack",
    "LiveTime": "1741178880",
    "RequestUuid": "ActivityReservationInfoCallBack-182575316419****",
    "Sign": "60ef92216c03191a7fe0402f65cd****",
    "SubAccountName": "admin@bytedance.com",
    "Timestamp": "1741178590",
    "UserInfos": [
        {
            "ExternalID": "",
            "Extra": "",
            "NickName": "",
            "ReservationTel": "1803738****",
            "UserAccessIP": "fdbd:dc00:5e************",
            "UserAgent": "Windows 10",
            "UserID": ""
        }
    ],
    "ViewUrl": "https://example.com/6326********/1300********"
}

超时重试

回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。

参数

说明

请联系技术支持获取鉴权 AccountSecret

参数

类型

说明

AccountID

String

账号 ID。

ActivityID

String

直播间 ID。

SubAccountName

String

创建直播间的账号。参数值 admin@bytedance.com 表示直播间为主账号创建。

EventType

String

回调通知的事件类型,固定取值为 ActivityReservationInfoCallBack

Timestamp

String

发送回调请求的时间。Unix 时间戳,单位为秒。

Sign

String

校验签名。
完成以下步骤,计算校验签名。

  1. 按照 AccountSecretAccountIDActivityIDEventTypeTimestamp 的顺序,拼接对应的参数值。
  2. 将拼接后的内容进行 MD5 加密生成 32 位小写字符串。

ActivityName

String

直播间标题。

ViewUrl

String

观看地址。若您进行了品牌定制,则返回品牌定制后的观看地址。有关如何进行控制台品牌定制,详见控制台品牌定制

LiveTime

String

开播时间。Unix 时间戳,单位为秒。

RequestUuid

String

请求回调的唯一标识。

UserInfos

Array of UserReservationInfo

预约用户信息。

UserReservationInfo

参数值

类型

描述

UserID

String

用户 ID。

ExternalID

String

关联用户 ID,即用户在第三方平台的唯一标识。
您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。
用户通过不同方式登录直播间,关联用户 ID 的取值如下所示。

  • 微信:观众在企业直播微信服务号的 OpenID。
  • 企业微信:绑定企业直播的企业内部成员 OpenID。
  • 自定义:自定义登录时通过 UserId 传入的值。详见自定义登录
  • OAuth 2.0:您自有账号系统中用户 ID 对应的字段。
  • 飞书:绑定企业直播的飞书企业成员 Open ID。
  • 手机号:观众通过手机号注册企业直播后生成的 passport_id。
  • 白名单:观众输入的白名单校验信息。

说明

如果您集成了观播 SDK,且 SDK 的鉴权模式为自定义模式,关联用户 ID 的取值为调用 GetSDKTokenAPI 接口时传入的 UserIdStr(观众 ID)。

Extra

String

业务方扩展参数,对应观看页地址中的 extra 字段,例如:https://live.xxx.com/9854/1315744?extra=xxx

说明

对于 iOS、Android 或 Flutter SDK,该参数无值。

NickName

String

用户昵称。

说明

仅在用户登录直播间时,该参数有值。

UserAccessIP

String

用户 IP 地址。

UserAgent

String

用户终端类型。

ReservationTel

String

用户预约直播的手机号。

说明

  • 对于 iOS、Android 或 Flutter SDK,该参数无值。
  • 仅在开启短信提醒功能后,该参数有值。有关如何开启短信提醒功能,详见直播预约