文档首页/ 实时音视频 SparkRTC/ API参考/ 应用回调管理/ 查询增值(录制)事件回调配置
更新时间:2024-10-18 GMT+08:00

查询增值(录制)事件回调配置

功能介绍

调用此接口查询增值(录制)事件回调配置

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

app_id

String

应用id

请求参数

表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信息。

响应参数

状态码: 200

表3 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表4 响应Body参数

参数

参数类型

描述

app_id

String

应用id

record_callback

AppCallbackUrl object

回调信息

表5 AppCallbackUrl

参数

参数类型

描述

url

String

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

auth_key

String

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

notify_event_subscription

Array of strings

订阅云端录制通知消息。

取值如下:

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

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

update_time

String

更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC。

状态码: 400

表6 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表8 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询指定应用id的增值(录制)事件回调配置

GET https://rtc-api.myhuaweicloud.com/v2/apps/{app_id}/record-callback

响应示例

状态码: 200

app详细信息

{
  "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"
  }
}

状态码: 400

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

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

状态码: 404

app编号不存在

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

状态码: 500

查询失败,服务器端错误

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

状态码

状态码

描述

200

app详细信息

400

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

404

app编号不存在

500

查询失败,服务器端错误

错误码

请参见错误码