配合直播预约功能使用,直播开始前回调预约用户信息。
将接收回调通知的接口地址提供给企业直播技术支持。
设置回调的接口地址后,企业直播会根据您直播间配置的短信提醒时间,定时发送回调消息。例如,直播间开播时间为 19:00,您配置的短信提醒时间为开播前 5 分钟,则企业直播将在 18:55 向回调地址发送回调消息。回调消息以 POST 方式发送,包含直播间的 ID 以及预约观众的信息。单条回调消息可包含 2000 位预约观众的信息;若观众数超出 2000,将分为多条回调消息。关于直播间预约短信发送时间的配置方法,请参见直播预约文档。
回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
注意
请联系技术支持获取鉴权 AccountSecret。
参数 | 类型 | 说明 |
---|---|---|
AccountID | String | 用户账号的 ID。 |
ActivityID | String | 直播间 ID。 |
EventType | String | ActivityReservationInfoCallBack |
Timestamp | String | 发送回调请求的时间。Unix 时间戳,单位为秒。 |
Sign | String | 校验的加密字符串,生成的规则 md5(AccountSecret + AccountID + ActivityID + EventType + Timestamp)。 |
ActivityName | String | 直播间标题。 |
ViewUrl | String | 观看地址。若您进行了品牌定制,则返回品牌定制后的观看地址。有关如何进行控制台品牌定制,详见控制台品牌定制。 |
LiveTime | String | 开播时间。 |
RequestUuid | String | 请求回调的唯一标识。 |
UserInfos | Array of UserReservationInfo | 预约用户信息。 |
参数值 | 类型 | 描述 |
---|---|---|
UserID | String | 用户 ID。 说明 用户必须登录直播间才可以显示该参数。 |
ExternalID | String | 观众在第三方平台的唯一标识。您可以根据该关联用户 ID 识别企业自身的用户身份,以便于按需实现用户洞察和进行数据分析。观众通过不同方式登录直播间时,关联用户 ID 取值不同,具体取值情况详见数据统计。 说明 用户必须登录直播间才可以显示该参数。 |
Extra | String | 业务方扩展参数,对应观看页地址中的 extra 字段,例如:https://live.xxx.com/9854/1315744?extra=xxx。 |
NickName | String | 用户昵称。 说明 用户必须登录直播间才可以显示该参数。 |
UserAccessIP | String | 用户 IP 地址。 |
UserAgent | String | 用户终端类型。 |
ReservationTel | String | 用户预约直播的手机号。 说明 仅在开启短信提醒功能后,才可以显示该参数。关于如何开启短信提醒功能,详见直播预约。 |