接口功能介绍
支持创建截图任务。
使用说明
使用直播截图功能前，需先开通媒体存储。
如果需要使用该接口，则不能开启 http强制跳转https功能。
接口详情
请求方式：POST
请求路径：/live/snapshot/create-snapshot
请求参数
| 参数名 | 类型 | 名称 | 是否必填 | 说明 |
|---|---|---|---|---|
| DomainName | string | 域名 | 是 | 拉流域名 |
| App | string | 频道名 | 是 | - |
| Stream | string | 流名 | 是 | - |
| Params | object | 截图参数配置 | 是 | - |
| Params.Output | object array | 输出参数 | 是 | 目前只支持配置一个 |
| Params.Output[*].Format | string | 输出图片的封装格式 | 是 | 支持jpg、png，格式名统一小写 |
| Params.Output[*].Interval | string | 截图间隔时长，单位秒 | 否 | 取值范围为5至86400，默认10秒 |
| Params.XOSAccessKey | string | XOS存储的访问密钥 | 是 | 长度限制为1至255个字符 |
| Params.XOSSecretKey | string | XOS存储的访问密钥 | 是 | 长度限制为1至255个字符 |
| Params.XOSBucket | string | XOS存储的Bucket名称 | 是 | 长度限制为1至255个字符 |
| Params.XOSRegion | string | XOS存储的Region名称 | 是 | 长度限制为1至255个字符 |
| Params.XOSEndpoint | string | XOS存储的服务地址，例如：http://XOS.ctcdn.com。 备注：完整的上传地址url由worker依据上传接口拼接合成 |
是 | 长度限制为1至255个字符 |
| Params.SnapshotNotifyUrl | string | 截图文件回调通知URL | 否 | 长度限制为1至255个字符 |
响应参数
| 参数名 | 类型 | 名称 |
|---|---|---|
| code | int | 状态码，成功时为100000 |
| message | string | 描述信息，成功时为success |
| TaskID | string | 任务id |
示例
请求路径：https://cdnapi-global.ctapi.ctyun.cn/live/snapshot/create-snapshot
请求示例
{
"App":"app-1",
"DomainName":"ctyun.cn",
"Params":{
"XOSBucket":"bucket",
"XOSSecretKey":"test",
"XOSRegion":"region",
"Output":[
{
"Format":"jpg",
"Interval":"10"
}
],
"SnapshotNotifyUrl":"http://aaa.ctyun.cn/notify",
"XOSAccessKey":"akey"
},
"Stream":"stream-1"
}
正确响应示例
{
"code":100000,
"message":"success",
"taskID":"123"
}
错误码请参考: 参数code和message含义
