You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/直播消息回调/直播间数据导出回调
直播间数据导出回调
最近更新时间：2024.11.27 10:46:11首次发布时间：2024.11.27 10:46:11
我的收藏

作用

在成功调用 ExportActivityData 接口导出直播间数据时，企业直播会对所设置的接口地址进行回调通知。

配置方式

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

详情

设置回调的接口地址后，当您成功调用 ExportActivityData 接口导出直播间数据时，企业直播会将直播间 ID 以及导出结果、导出的数据文件链接等导出信息以 POST 方式提交给您自定义的回调接口地址。
请求示例如下所示：

POST /xxxxx HTTP/1.1
Header1: ...
Header2: ...
...
{
    "Sign": "1c3eaec5945cfd****b5a9b7dba755ef",
    "ActivityId": "18154****61561",
    "DataType": "1",
    "EventType": "ActivityDataExportCallBack",
    "ExportId": "1877****1234"
    "FileUrl": "https://livesaas-medialib.tos-cn-beijing.volces.com/18161459****4970lb9bazqe/query_total_2024-11-20.xlsx?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=AKL****Y%2F20241120%2Fcn-beijing%2Ftos%2Frequest&X-Tos-Date=20241120T070515Z&X-Tos-Expires=15552000&X-Tos-Signature=ae4ecb06606598920b8b3d429fe1ae****28366586da44f1d5b2b20cce749943&X-Tos-SignedHeaders=host",
    "Status": "2",
    "RequestUuid": "ActivityDataExportCallBack-18136904****6208",
}

超时重试

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

参数

说明

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

参数

类型

说明

Sign

String

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

  1. 按照 AccountSecret、ActivityId、DataType、EventType、ExportId、Status 的顺序，拼接对应的参数值。
  2. 将拼接后的内容进行 MD5 加密生成 32 位小写字符串。

ActivityId

String

直播间 ID。

DataType

String

直播间数据类型。目前仅支持取值 1，即直播间的以下基础数据。

  • 页面访问数据：访问人次、访问人数、访问人数峰值、累计访问时长、人均访问时长、人均访问次数
  • 播放器观看数据：预告、直播、回放和总观看的观看人次、观看人数、观看人数峰值、累计观看时长、人均观看时长和人均观看次数

EventType

String

回调通知的事件类型，固定取值为 ActivityDataExportCallBack。

ExportId

String

导出记录 ID，是导出任务的唯一标识。

FileUrl

String

导出的数据文件链接，文件格式为 XLSX。链接包含协议头，有效期为 180 天。

Status

String

导出结果。取值如下：

  • 2：导出成功。
  • 3：导出失败。

RequestUuid

String

请求回调的唯一标识。