云端截图 | 开发文档

云端截图功能，常用于多人视频通话的房间抽检。每请求一次云端截图接口，云端便会对指定房间中的所有视频进行截图操作，每个视频生成一张图片，并返回 url 供图片下载。生成的图片将在野狗通信云暂存 15 天，请及时将云端的图片同步到你的存储服务器，以免遗失带来的不便。

云端截图功能，请求参数中包含 adminToken ，仅限于拥有管理员权限的用户进行调用，请参考身份认证中的 adminToken 的生成方式。

URL

https://bt-sh-api.wilddog.com/v2/snapshot

HTTP 请求方式

GET

接口频率限制

每30秒允许请求一次

返回数据格式

JSON

请求参数

参数	类型	必填	说明
appId	string	是	使用音视频通信的VideoAppID
roomId	string	是	多人视频通话中的roomID,房间号
token	string	是	使用野狗身份认证的 adminToken

请求示例

curl 'https://bt-sh-api.wilddog.com/v2/snapshot?appId=<appId>&roomId=<roomId>&token=<adminToken>'

返回参数

参数	类型	必填	说明
code	int	是	响应状态码，0 表示成功，非 0 表示失败
url	array	否	生成的截图地址列表，每个地址对应一个视频截图，该字段为字符串数组，只有当 code 为 0 时返回
message	string	否	错误提示信息，只有当 code 非 0 时返回

返回示例
正常返回如下：

{
    "code": 0,
    "url": [
        "http://bt-sh-download.wdstatic.cn/snapshot/20171211/wildrtc/112233@wildrtc_172007562460416770_1512992803316.jpg",
        "http://bt-sh-download.wdstatic.cn/snapshot/20171211/wildrtc/112233@wildrtc_766799604921847300_1512992803316.jpg"
    ]
}

异常返回如下：

{
    "code": 41201,
    "message": "Invalid parameter."
}

注意：

图片文件名生成规则为：roomId@appId_streamId_ts.jpg，ts 为收到截图请求时的服务端时间戳，精确到毫秒。

截图请求与实际的截图操作是异步的，接口返回 url 时，并不能保证截图已经生成，请在获取到 url 后再延迟一段时间下载。

上次更新：2018-06-21