设置特定事件的通知机制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CallbackType | string | 否 | 回调方式,取值:
| HTTP |
CallbackQueueName | string | 否 | 所在区域的MNS队列名称,必须以 ice-callback- 开头 | ice-callback-queue |
CallbackURL | string | 否 | 回调地址。回调方式为HTTP时,需设置此参数。 回调地址URL的长度不能超过256个字节,不支持设置多个回调地址。 | http://xxx.yyy/callback |
EventTypeList | string | 否 | 回调事件类型, 支持多值,以逗号分隔。 ProduceMediaComplete:剪辑合成作业完成 | ProduceMediaComplete |
AuthSwitch | string | 否 | HTTP回调的鉴权开关,回调方式设置为HTTP时,此参数有效。取值:
| on |
AuthKey | string | 否 | 鉴权Key,最长32位,必须同时包含大小写字母和数字。回调方式为HTTP时,可设置此参数。 | TestKey001 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2021-06-25 | 新增 OpenAPI |