添加录制规则
功能介绍
添加录制规则
接口约束
URI
POST /openapi/v1/rtcLive/addRule
请求参数
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
appId |
String |
Y |
应用ID |
|
storageType |
String |
Y |
存储类型 |
|
recordPath |
String |
N |
存储路径 |
|
filename |
String |
Y |
文件名称 |
|
captureInterval |
Integer |
N |
截帧间隔 |
|
captureNums |
Integer |
N |
截帧数量 |
|
recordingType |
Integer |
Y |
录制类型 |
|
callbackUrl |
String |
Y |
回调URL |
|
extraData |
String |
N |
透传参数 |
|
recordingModel |
String |
Y |
录制模式 |
|
mixingEnabled |
String |
N |
录制模式 |
|
status |
Boolean |
Y |
状态 |
表8.7.1-1请求参数
响应参数
接口字段 |
字段类型 |
是否必填 |
说明 |
备注 |
errorCode |
int |
|
状态码 |
请参考错误码为空说明成功 |
errorMessage |
String |
|
消息内容 |
SUCCESS,FAIL |
timestamp |
String |
|
时间 |
|
data |
Object |
|
响应内容 |
见data参数 |
表8.7.1-2响应参数
请求示例
{ "recordingType":0, "appId":"test", "recordingModel":0, "recordPath":"/saas/application/", "fileName":"AICC_{channel_id}", "callbackUrl":"https://www.baidu.com", "storageType":"NAS", "mixingEnabled":0, "status": true }
响应示例
成功返回示例:
{ "errorCode":"0", "errorMessage": null, "timestamp":"2021-12-15T18:41:14.369+0800", "data": { "recordRuleId": 1031 } }
错误示例:
{ "errorCode":1001001, "errorMessage":"PARAM_IS_INVALID", "timestamp":"2021-12-15T18:41:14.369+0800", "data":null }