• 沒有找到結果。

8.1 配置 RTC 增值(录制)事件回调

功能介绍

调用此接口配置增值(录制)事件上报回调。

当任务发生订阅了的事件时,通过该接口配置的回调地址通知。

回调内容请参见增值(录制)事件回调通知内容。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v2/apps/{app_id}/record-callback

8-1 路径参数

参数 是否必选 参数类型 描述

app_id 是 String 应用id

API 参考 8 应用回调管理

请求参数

8-2 请求 Header 参数

参数 是否必选 参数类型 描述

Content-Type 是 String 内容类型。

X-Auth-Token 否 String 用户Token。使用Token鉴权方 式时必选。通过调用IAM服务获 取用户Token接口获取(响应消 息头中X-Subject-Token的 值)。

Authorization 否 String 使用AK/SK方式认证时必选,携 带的鉴权信息。

X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请 求的发生时间。

X-Project-Id 否 String 使用AK/SK方式认证时必选,携 带项目ID信息。

8-3 请求 Body 参数

参数 是否必选 参数类型 描述

url 是 String 回调通知url地址,url必须以

http://或https://开头,需要支 持POST调用。

auth_key 否 String 回调秘钥,主要用于鉴权

响应参数

状态码: 200

8-4 响应 Header 参数

参数 参数类型 描述

X-request-Id String 此字段携带请求ID号,以便任务跟踪。

8-5 响应 Body 参数

参数 参数类型 描述

app_id String 应用id

API 参考 8 应用回调管理

参数 参数类型 描述 record_callbac

k AppCallback

Url object 回调信息

8-6 AppCallbackUrl

参数 参数类型 描述

url String 回调通知url地址,url必须以http://或https://开 头,需要支持POST调用。

auth_key String 回调秘钥,主要用于鉴权。如果不设置或者为 空,则回调不会增加鉴权头域字段。

notify_event_s

ubscription Array of

strings 订阅云端录制通知消息。

取值如下:

● RECORD_NEW_FILE_START:开始创建新的录 制文件。

● RECORD_FILE_COMPLETE:录制文件生成完 成。

update_time String 更新时间,形如

“2006-01-02T15:04:05.075Z”,时区为:

UTC。

状态码: 400

8-7 响应 Header 参数

参数 参数类型 描述

X-request-Id String 此字段携带请求ID号,以便任务跟踪。

8-8 响应 Body 参数

参数 参数类型 描述

error_code String 错误码 error_msg String 错误描述

状态码: 404

API 参考 8 应用回调管理

8-9 响应 Header 参数

参数 参数类型 描述

X-request-Id String 此字段携带请求ID号,以便任务跟踪。

8-10 响应 Body 参数

参数 参数类型 描述

error_code String 错误码 error_msg String 错误描述

状态码: 500

8-11 响应 Header 参数

参数 参数类型 描述

X-request-Id String 此字段携带请求ID号,以便任务跟踪。

8-12 响应 Body 参数

参数 参数类型 描述

error_code String 错误码 error_msg String 错误描述

请求示例

PUT https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-callback { "url" : "http://mydomain.com/callback",

"auth_key" : "8923ab8c2dcef4538923ab8c2dcef453"

}

响应示例

状态码: 200 配置成功

{ "app_id" : "123456789abcdefghijklmno", "record_callback" : {

"url" : "http://mydomain.com", "auth_key" : "78912374ae8cdb38",

"notify_event_subscription" : [ "RECORD_NEW_FILE_START", "RECORD_FILE_COMPLETE" ], "update_time" : "2020-07-26T07:53:05.075Z"

API 参考 8 应用回调管理

}}

状态码: 400

配置失败,语义有误,当前请求无法被服务器理解,或参数有误

{ "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"

}

状态码: 404

配置失败,应用不存在

{ "error_code" : "RTC.00001003", "error_msg" : "InvalidParameterValue"

}

状态码: 500

配置失败,服务器端错误

{ "error_code" : "RTC.00002xxx", "error_msg" : "InternalError"

}

状态码

状态码 描述

200 配置成功

400 配置失败,语义有误,当前请求无法被服务器理解,或参数有误 404 配置失败,应用不存在

500 配置失败,服务器端错误

错误码

请参见错误码。