You need to enable JavaScript to run this app.
导航
获取回调记录
最近更新时间:2025.01.10 17:28:12首次发布时间:2025.01.10 17:28:12

此接口用于获取特定空间下特定 Vid 在某一时间范围内的回调记录。

使用说明

关于视频点播的回调机制和事件详细信息,请参见事件通知概述

注意事项

  • 本接口的单用户 QPS 限制为 20 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

请求说明

请求地址:https://vod.volcengineapi.com?Action=GetCallbackRecordV2&Version=2023-01-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

参数
类型
是否必选
示例值
描述
Action
String
GetCallbackRecordV2
接口名称。当前 API 的名称为 GetCallbackRecordV2
Version
String
2023-01-01
接口版本。当前 API 的版本为 2023-01-01
SpaceName
String
doc-test
空间名称。可调用 ListSpace 接口获取当前账号下所有空间的名称。
Vid
String
v02b69g10000***eldb8vjafvmg
视频 ID。将音视频上传至视频点播服务后,您可通过 FileUploadComplete 事件通知获取 Vid
Status
String
success

回调状态。默认获取全部所有状态的记录。取值如下:

  • success: 成功。
  • fail: 失败。
StartTime
Integer
1736233200
查询起始时间。Unix 时间戳,精度为秒。
EndTime
Integer
1736236800

查询结束时间。Unix 时间戳,精度为秒。

说明

支持查询最近 7 天的回调记录。

Limit
Integer
200
返回结果数量。默认为 200。如果取值小于或等于 0,或者大于 200,均为 200。
EventType
String
FileUploadByUrlComplete
事件类型,取值请见事件列表
ContinuationToken
String
m93aUHkBy+k=.30413050385

下一页令牌。用于滚动查询。首次调用接口查询数据时无需设置该参数值(即参数值为空),第二次调用接口查询时将该参数值设置为首次查询返回参数中 ContinuationToken 的值,第三次调用接口查询时将该参数值设置为第二次查询返回参数中 ContinuationToken 的值,依次类推。

说明

使用滚动查询时,除 ContinuationToken 参数外,其它参数的值建议保持不变。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数
类型
示例值
描述
CallbackEvents
Object[]
-
回调事件列表。
EventType
String
DeleteMediaComplete
事件类型,取值请见事件列表
CallbackName
String
_tob_doc-test
回调名称。
CallbackType
String
http
回调类型,当前仅支持 http
CallbackMessage
String
{"Data":{"CallbackArgs":"","Code":"Success","FileId":"","FileNames":["tos-vod-v-bfbc1489b0ce29a2/oIFv98OnYsh2BMPgfIsgDUBYHED"],"Message":"Success","StrategyID":"","Vid":"v0c146g7007bctgdnjv***pgfk363c0"},"EventTime":"2024-12-17T06:17:09Z","EventType":"DeleteMediaComplete","RequestId":"021734416229348fdbdfdbdfdbdfdbd000000000000006082b7f1","TaskType":"DelVideo","Version":"1.0"}
回调信息,JSON 格式。不同类型事件的具体字段说明请见事件列表
Status
String
success

回调状态。取值如下:

  • success: 获取状态为成功的回调记录。
  • error: 获取状态为失败的回调记录。
EventTime
Integer
1734416229858
事件发生时间。Unix 时间戳,精度为秒。
Vid
String
v0c146g7007bc***njvog65pgfk363c0
视频 ID。
CallbackUrl
String
http://test.bytedance.com/callback_v2
回调地址。
LogId
String
021734416229348fdbdfdbdfdbdfdbd000000000000006082b7f1
日志 ID。
Limit
Integer
200
返回结果数量。
ContinuationToken
String
m93aUHkBy+k=.30413050385
下一页令牌。如果没有下一页则返回空字符串。

请求示例

https://vod.volcengineapi.com?Action=GetCallbackRecordV2&Version=2023-01-01&SpaceName=doc-test&Status=success&StartTime=1736233200&EndTime=1736236800&Limit=200&EventType=FileUploadByUrlComplete&ContinuationToken=m93aUHkBy+k=.30413050385&Vid=v02b69g10000***eldb8vjafvmg

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetCallbackRecordV2",
        "Version": "2023-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "CallbackEvents": [
            {
                "EventType": "DeleteMediaComplete",
                "CallbackName": "_tob_doc-test",
                "CallbackType": "http",
                "CallbackMessage": "{\"Data\":{\"CallbackArgs\":\"\",\"Code\":\"Success\",\"FileId\":\"\",\"FileNames\":[\"tos-vod-v-bfbc1489b0ce29a2/oIFv98OnYsh2BMPgfIsgDUBYHED\"],\"Message\":\"Success\",\"StrategyID\":\"\",\"Vid\":\"v0c146g7007bctgdnjv***pgfk363c0\"},\"EventTime\":\"2024-12-17T06:17:09Z\",\"EventType\":\"DeleteMediaComplete\",\"RequestId\":\"021734416229348fdbdfdbdfdbdfdbd000000000000006082b7f1\",\"TaskType\":\"DelVideo\",\"Version\":\"1.0\"}",
                "Status": "success",
                "EventTime": 1734416229858,
                "Vid": "v0c146g7007bc***njvog65pgfk363c0",
                "CallbackUrl": "http://test.bytedance.com/callback_v2",
                "LogId": "021734416229348fdbdfdbdfdbdfdbd000000000000006082b7f1"
            }
        ],
        "Limit": 200,
        "ContinuationToken": "m93aUHkBy+k=.30413050385"
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,详见视频点播公共错误码

状态码错误码错误信息说明

400

InvalidParameterr.InvalidContinuationToken

Invalid ContinuationToken

ContinuationToken 参数无效,可能原因:

  • 字符长度超过 64
  • 解析错误
  • 解析结果大于 EndTime 小于 StartTime

服务端 SDK

建议通过视频点播服务端 SDK 来调用 API,实现快速开发。此 API 各语言调用的示例代码,请参考如下: