有奖捉虫:行业应用 & 管理与支持文档专题 HOT

1. 接口描述

接口请求域名: ivld.tencentcloudapi.com 。

用户设置对应事件的回调地址

回调事件消息通知协议

网络协议

  • 回调接口协议目前仅支持http/https协议;
  • 请求:HTTP POST 请求,包体内容为 JSON,每一种消息的具体包体内容参见后文。
  • 应答:HTTP STATUS CODE = 200,服务端忽略应答包具体内容,为了协议友好,建议客户应答内容携带 JSON: {"code":0}

通知可靠性

事件通知服务具备重试能力,事件通知失败后会总计重试3次;
为了避免重试对您的服务器以及网络带宽造成冲击,请保持正常回包。触发重试条件如下:

  • 长时间(5 秒)未回包应答。
  • 应答 HTTP STATUS 不为200。

回调接口协议

分析任务完成消息回调
参数名称 必选 类型 描述
EventType int 回调时间类型,1-任务分析完成,2-媒资导入完成
TaskId String 任务ID
TaskStatus TaskStatus 任务执行状态
FailedReason String 若任务失败,该字段为失败原因
导入媒资完成消息回调
参数名称 必选 类型 描述
EventType int 回调时间类型,1-任务分析完成,2-媒资导入完成
MediaId String 媒资ID
MediaStatus MediaStatus 媒资导入状态
FailedReason String 若任务失败,该字段为失败原因

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyCallback。
Version String 公共参数,本接口取值:2021-09-03。
Region String 公共参数,详见产品支持的 地域列表
TaskFinishNotifyURL String 任务分析完成后回调地址
示例值:http://xxxx.com
MediaFinishNotifyURL String 媒体导入完成后回调地址
示例值:http://xxxx.com

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功设置回调地址

输入示例

POST / HTTP/1.1
Host: ivld.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCallback
<公共请求参数>

{
    "TaskFinishNotifyURL": "https://callback.com",
    "MediaFinishNotifyURL": "https://callback.com"
}

输出示例

{
    "Response": {
        "RequestId": "705f6aed-f46b-4f43-aeef-31167885d938"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure.UserInvalidStatus 用户状态异常。
AuthFailure.UserNotFound 用户无权限。
AuthFailure.UserStopArrear 用户已欠费停服。
InternalError 内部错误。
InternalError.DBConnectionError 内部DB连接失败。
InternalError.InnerError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.InvalidParam 输入字段 %!s(MISSING) 不合法。
InvalidParameter.InvalidURL URL不合法。
InvalidParameter.NameTooLong 名称超过长度限制。
InvalidParameter.ParamTooLong 参数超过长度限制。
InvalidParameter.URLNotResolved 输入URL域名无法解析。
InvalidParameter.UnsupportURL 不支持的URL类型。
UnauthorizedOperation.UnauthorizedProduct 用户未激活该产品。