回调管理

更新时间: 2025/01/17 17:47:24

回调是网易云信提供的一种异步通知方式,用户可设置回调地址,网易云信完成某个特定任务后会将运行结果发送至设置的回调地址,用户可在收到回调后执行相应的业务逻辑。回调管理模块提供了回调地址的查询和删除功能,方便用户查看或删除回调地址。

设置回调地址

网易云信点播的回调通知分为单个级别和用户级别,且处理优先级为:单个级别->用户级别->无回调。当用户设置了单个级别的回调地址,使用单个级别的回调地址。否则查询是否设置用户级别的回调地址,如果设置,使用用户级别的回调地址。否则不回调通知。单个级别的回调通知在上传初始化中指定,用户级别的回调通知可通过本接口设置。

回调通知会在请求头中增加 sign 字段,其值为拼接回调包体内容的字符串和签名字符串,然后对拼接后的字符串进行 md5 加密(32 位小写)。签名字符串可通过本接口设置,默认为:vcloud。

接口描述

  • 域名:vcloud.163.com

  • 接口名:POST /app/vod/callback/setUrl

用于设置指定类型的回调地址。

输入参数

参数 类型 是否必选 说明
type Int 回调地址类型,1 表示转码回调,2 表示上传回调,5 表示视频合并回调,6 表示视频裁剪回调
callbackUrl String 处理完成后回调的 URL 地址(需标准 http 格式,长度不超过 200)
signKey String 媒体处理成功后回调客户端的签名字符串,要求是由字母和数字组成且不超过 32 位

输出参数

参数 类型 说明
requestId String 请求标识。
code Int 状态码,详情请参考 状态码
msg String 错误信息。

请求示例

cURLcurl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05***af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a2***abe7ae13" -d '{"type":1,"callbackUrl":"http://123456xxxx"}' https://vcloud.163.com/app/vod/callback/setUrl

返回示例

JSON{
    "requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",
    "code" : 200
}

回调地址查询

用于查询指定类型的回调地址。

接口描述

  • 域名:vcloud.163.com

  • 接口名:/app/vod/callback/getUrl

输入参数

参数 类型 是否必选 说明
type Int 回调地址类型:1 表示转码回调,2 表示上传回调,5 表示视频合并回调,6 表示视频裁剪回调

输出参数

参数 类型 说明
code Int 状态码,详情请参考 状态码
callbackUrl String 回调地址。
lastUpdateTime String 最近更新时间(yyyy-MM-dd HH:mm:ss)。
msg String 错误信息。

请求示例

cURLcurl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05***af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a2***abe7ae13" -d '{"type":1}' https://vcloud.163.com/app/vod/callback/getUrl

返回示例

JSON{
  "ret": {
    "callbackUrl": "http://***.com/callback",
    "lastUpdateTime": "2019-01-15 14:01:14"
  },
  "code": 200
}

删除回调地址

接口描述

  • 域名:vcloud.163.com

  • 接口名:/app/vod/callback/delUrl

用于删除指定类型的回调地址,调用本接口后,您不会再收到相应类型的回调信息。

输入参数

参数 类型 是否必选 说明
type Int 回调地址类型:1 表示转码回调,2 表示上传回调,5 表示视频合并回调,6 表示视频裁剪回调

输出参数

参数 类型 说明
code Int 状态码,详情请参考 状态码
msg String 错误信息。

请求示例

cURLcurl -X POST -H "Content-Type: application/json;charset=utf-8" -H "AppKey: 027338bf05***af80b3" -H "Nonce: 1" -H "CurTime: 1465723418" -H "CheckSum: 61bbfd88c51028a2a2***abe7ae13" -d '{"type":1}' https://vcloud.163.com/app/vod/callback/delUrl

返回示例

JSON{
  "code": 200
}
此文档是否对你有帮助?
有帮助
去反馈
  • 设置回调地址
  • 回调地址查询
  • 删除回调地址