视频截图
功能介绍：视频截图
接口约束：
URI: /openapi/v1/rtcLive/captureImage
请求参数
接口字段 | 字段类型 | 是否必填 | 说明 | 备注 |
channelId | String | 频道ID | 三方自行生成，字符串类型，1~64位，由大小写字母、数字、下划线（_）、短划线（-）组成，需要租户下唯一，相同channelId入会会进入同一频道 | |
appId | String | 应用ID | appId申请见3.1新建应用获取应用Id和令牌 | |
userId | String | 用户ID | 要截图的用户id | |
recordRuleId | String | 录制规则ID | 录制规则由ISDP系统提供，暂不对外提供配置，规则id包含的配置请参考recordRule对象 recordRuleId: 生成appid后，提供给ISDP平台，通过appId生成 | |
recordPath | String | 存储路径 | 录制文件存储路径，完整路径为basePath+recordPath 如果传入此参数，文件路径参考规则recordRule配置项里的recordPath字段，且支持可变参数 | |
callbackUrl | String | 回调URL | 第三方提供的回调地址 | |
extraData | String | 回调头传参数 | 支持最大1000位字节 | |
fileName | String | 文件名称 | 支持可变参数{date_time},{channel_id} 区分大小写 举例： 1、fileName =AICC_{date_time}_{channel_id}。 2、如果不传入：由系统自动生成。 文件后缀由系统自动补充。 |
表8.5.2-1请求参数
recordRule对象的配置参数如下：
接口字段 | 字段类型 | 是否必填 | 说明 | 备注 |
callbackUrl | String | Y | 回调地址 | 录制成功后调用此地址返回录制结果信息。 用户提供的以http、https开头的完整的url,例如：https://xx/pushCallBack |
storage_type | String | Y | 存储类型 | 1、当存储类型为NAS时图片按recordPath路径存储在NAS共享盘中。 2、当存储类型为ISDP则以base64图片格式返回。 默认：ISDP |
capture_interval | Int | N | 截帧间隔 | 截帧间隔默认1s |
capture_nums | Int | N | 截帧数量 | 截帧数量默认1张 |
表8.5.2-2recordRule对象配置参数
响应参数
接口字段 | 字段类型 | 是否必填 | 说明 | 备注 |
errorCode | int | 状态码 | 请参考错误码为空说明成功 | |
errorMessage | String | 消息内容 | SUCCESS,FAIL | |
timestamp | String | 时间 | ||
data | Object | 响应内容 | 见data参数 |
表8.5.2-3响应参数
data参数
接口字段 | 字段类型 | 是否必填 | 说明 | 备注 |
recordingId | String | 录制id |
表8.5.2-3 data参数
请求示例
请求示例：
{
"channelId":"23198805",
"appId":"*************************jLAzFN5"，
"userId":"444445",
"recordRuleId":"1002"，
"recordPath":"/saas/application/{channel_id}/{app_id}/",
"fileName":"AICC_{channel_id}",
"extraData":"",
"callBackUrl":" http://localhost:8900/receive/recipeImage"
} 响应示例
成功返回示例：
{
"errorCode":"0",
"errorMessage": null,
"timestamp":"2021-12-15T18:41:14.369+0800",
"data": {
"recordingId": "xxxxxxxxxxxxxxxxxxxx"
}
} 错误示例：
{
"errorCode":1001001,
"errorMessage":"PARAM_IS_INVALID",
"timestamp":"2021-12-15T18:41:14.369+0800",
"data":null
} 
