状态回调
融云的云端截图服务,支持将截图的状态变化实时通知您的服务器。
您可以在控制台的云端截图页面,填写接收 HTTP 回调的 URL,配置后 15 分钟内 生效。
回调地址示例:http(s)://your.app.server/any-url-path
配置完成后,您的 App 内所有房间的截图有任何状态变更,均会通过 HTTP 请求,实时回调您的服务器。
使用说明:
注意
必须已开通音视频服务和云端截图服务。您填写回调 URL 必须是公网可访问的 URL 地址。
回调方法
POST:<your-receiving-server-url>
数据格式:application/json
回调地址 <your-receiving-server-url>
是您在控制台为当前 App Key 和服务所配置的回调接收地址。请务必配置可正常访问的回调接收地址。如果您的网络有 IP 访问限制,请务必配置 IP 白名单,否则无法正常接收服务端回调。
为了验证数据有效性并确保调用者为融云 Server,每个请求前添加数据签名。回调签名规则详见服务端回调。
状态回调公共字段说明
字段名称 | 类型 | 说明 |
---|---|---|
type | Number | 1:开始截图;3:截图结束;4:上传文件 |
sessionId | String | 这次会话的ID |
extra | String | 扩展字段,回调时候透传 |
appKey | String | 用户申请的AppKey |
roomId | String | 所在房间ID |
imageId | String | 截图会话 ID |
code | Number | 状态码 |
errorMessage | String | 状态描述 |
截图开始的回调
云端截图服务会在截图开始时,回调此次截图任务的模式、配置、封装文件格式等信息。
具体字段说明如下:
字段名称 | 类型 | 说明 |
---|---|---|
config.trigger | String | 标志截图服务:手动出发还是自动触发 |
config.slicesSec | String | 截图间隔 |
config.renderMode | Number | 截图模式 |
config.picResolution | String | 截图生成的分辨率 |
回调 Body 示例如下。
请求示例
HTTP
POST /any-url-path HTTP/1.1
Host: your.app.server
Content-Type: application/json
{
"timestamp": 1530027865231,
"type": 1,
"appKey": "e0x9wycfx7flq",
"sessionId": "lSA2G6CUf9A-6nnoNwXCx8",
"roomId": "111",
"imageId": "SJGOSOIOAIJFOJAOJOE",
"extra":"", //扩展字段
"config": {
"trigger": 0,
"slicesSec": 30,
"renderMode": 1,
"picResolution": "640x480"
},
"code": 200,
"errorMessage": "Success"
}