当您在企业直播控制台的消息中心接收到以下类型的消息时,企业直播会对所设置的接口地址进行回调通知:
完成回调配置。详见回调配置。
完成回调配置后,当接收到违规和举报消息时,企业直播系统会将接收消息的主账号 ID、相关直播间 ID、创建直播间的子账号名称、消息类型、消息具体内容等信息以 POST 方式提交给您设置的回调地址。请求示例如下所示。
直播违规警告信息示例:
POST /xxxxx HTTP/1.1 Header1: ... Header2: ... ... { "AccountId": "200000****", "ActivityId": "182573526550****", "ActivityName": "直播间 A", "ActivityTags": "{\"SelectTags\":[{\"Name\":\"标签 1\",\"Index\":1,\"Value\":\"A\",\"TagType\":0},{\"Name\":\"标签 2\",\"Index\":2,\"Value\":\"B\",\"TagType\":0}],\"TextTags\":[{\"Name\":\"标签 3\",\"Index\":0,\"Value\":\"C\",\"TagType\":1},{\"Name\":\"标签 4\",\"Index\":1,\"Value\":\"D\",\"TagType\":1}]}", "EventType": "WarningReportCallback", "MessageContent": " 您的直播【直播间 A】在2022-12-02 19:17:49因涉及展示或谈论敏感事件问题被警告,请及时规范直播内容,如涉及违规立即中断。注意被警告或中断的直播无法生成回放。", "MessageType": "3", "RequestUuid": "WarningReportCallback-185161483510****", "Sign": "f3227d*********f740dc9c9", "SubAccountName": "admin@bytedance.com", "Timestamp": "1765981314" }
直播举报信息示例:
POST /xxxxx HTTP/1.1 Header1: ... Header2: ... ... { "AccountId": "200000****", "ActivityId": "182573526550****", "ActivityName": "直播间 A", "ActivityTags": "{\"SelectTags\":[{\"Name\":\"标签 1\",\"Index\":1,\"Value\":\"A\",\"TagType\":0},{\"Name\":\"标签 2\",\"Index\":2,\"Value\":\"B\",\"TagType\":0}],\"TextTags\":[{\"Name\":\"标签 3\",\"Index\":0,\"Value\":\"C\",\"TagType\":1},{\"Name\":\"标签 4\",\"Index\":1,\"Value\":\"D\",\"TagType\":1}]}", "EventType": "WarningReportCallback", "MessageContent": "观众 A 在直播间 北京分会场 发起举报,举报原因:侮辱谩骂,举报描述: 这个直播间不太好", "RelatedScreenShot": "https://livesaas.zebracdn.com/tos-cn-i-xtjplaems7/e620808e5f3f42928f2c0eac64e5b78f~tplv-xtjplaems7-image.image?sign=1765982056-rand-imagex-5dd3b5ab0fd27234819e53**********", "MessageType": "11", "RequestUuid": "WarningReportCallback-185175755472****", "Sign": "ef9********636181d9c448c2d14c768", "SubAccountName": "admin@bytedance.com", "Timestamp": "1765982056" }
回调服务器在发送消息通知后,5 秒内没有收到您的服务器的响应,即认为通知失败。后续会以 5 秒为间隔继续重试 2 次。
回调请求体为一个 JSON 对象,包含以下参数。
字段名 | 类型 | 说明 |
|---|---|---|
| String | 主账号 ID。 |
| String | 直播间 ID。 |
| String | 创建直播间的子账号名称。 |
| String | 回调通知的事件类型,固定取值为 |
| String | 接收到的信息类型。取值如下:
|
| String | 发送回调请求的时间。Unix 时间戳,单位为秒。 |
| String | 校验签名。
说明
|
| String | 直播间标题。 |
| String | 消息详情内容。 |
| String | 消息详情中除图片和链接(如有)以外的内容。 |
| String | 直播举报时,观众附上的相关截图。 说明 仅当 |
| String | 直播间配置的标签信息。详见 说明 仅在直播间配置了分类标签或文本标签值时,该参数有值 |
| String | 请求回调的唯一标识。由于回调通知可能被重复推送,您可使用该字段作为幂等键,避免重复处理同一回调。 |
ActivityTags
参数 | 类型 | 描述 |
|---|---|---|
SelectTags | Array of ActivityTag | 直播间分类标签列表。 |
TextTags | Array of ActivityTag | 直播间文本标签列表。 |
ActivityTag
参数 | 类型 | 描述 |
|---|---|---|
Index | Integer | 标签的索引值,用于标识标签在控制台展示的位置。索引值越小,位置越靠前。取值从 |
Name | String | 标签名称。 |
Value | String | 标签值。 |
TagType | Integer | 标签类型。取值如下:
|