5 回调管理

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

5.1 设置回调地址

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

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

5.1.1 接口描述

域名:vcloud.163.com

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

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

5.1.2 输入参数

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

5.1.3 输出参数

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

5.1.4 响应状态码

状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

5.1.5 示例代码

输入1

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

输出1

"Content-Type": "application/json; charset=utf-8"
{
    "requestId" : "vode49fdc9a-d59d-480d-b3ef-c91b37f8f664",
    "code" : 200        
}

5.2 回调地址查询

5.2.1 接口描述

域名:vcloud.163.com

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

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

5.2.2 输入参数

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

5.2.3 输出参数

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

5.2.4 响应状态码

状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

5.2.5 示例代码

输入1

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

输出1

{
  "ret": {
    "callbackUrl": "http://123456xxxx",
    "lastUpdateTime": "2019-01-15 14:01:14"
  },
  "code": 200
}

5.3 删除回调地址

5.3.1 接口描述

域名:vcloud.163.com

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

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

5.3.2 输入参数

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

5.3.3 输出参数

参数 类型 说明
code Int 状态码
msg String 错误信息

5.3.4 响应状态码

状态码 含义
200 操作成功
400 请求报文格式错误,报文构造不正确或者没有完整发送
700 服务器内部出现错误,请稍后重试或者将完整错误信息发送给客服人员帮忙解决
710 权限认证失败,请参考文档中的接口鉴权部分
711 请求参数非法,具体信息见msg
720 访问失败,余额不足
721 服务未开通,请前往开通页面申请服务开通
722 服务开通审核中,请联系客服人员开通服务
723 请求的次数超过了配额限制

5.3.5 示例代码

输入1

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

输出1

{
  "code": 200
}

###