获取 TikTok 账号 Webhook 配置
您可使用本接口获取开发者应用层级已有的与您的 TikTok 账号活动相关的 Webhook 事件配置。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/business/webhook/list/
方法 GET
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| app_id {必填} | string | 开发者应用 ID。<br><br>您可以导航至<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>，获取<strong>应用 ID</strong>。|
| secret {必填} | string[] | 开发者应用密钥。<br><br>您可以导航至<strong>[应用管理](https://ads.tiktok.com/marketing_api/apps/)</strong> > <strong>App Detail</strong> > <strong>基本信息</strong>，获取<strong>密钥</strong>。|
| event_type {必填} | string | 订阅的 Webhook 事件类型。<br><br>枚举值：<ul><li>`VIDEO`： 帖子发布事件，使您能获取通过某些 TikTok API 接口发布的内容的实时发布状态通知。<ul><li>若想了解此类事件类型中事件的结构和有效负载示例，请查看[帖子发布事件](1810515090228226.html)。 </li></ul></li><li>`COMMENT`：评论更新事件，包括 `comment.update` 事件。<ul><li>若想了解此类事件类型中事件的结构和有效负载示例，请查看[评论更新事件](1810515104773122.html)。</li></ul></li></ul> |
示例
获取一个现有的 Webhook 配置
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/business/webhook/list/?app_id={{app_id}}&secret={{secret}}&event_type=VIDEO'
(/code)
获取一个空的 Webhook 配置
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/business/webhook/list/?app_id={{app_id}}&secret={{secret}}&event_type=VIDEO'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#| app_id | string | 开发者应用 ID。 |
#| event_type | string | 订阅的 Webhook 事件类型。<br><br>枚举值：<ul><li>`VIDEO`： 帖子发布事件，使您能获取通过某些 TikTok API 接口发布的内容的实时发布状态通知。<ul><li>若想了解此类事件类型中事件的结构和有效负载示例，请查看[帖子发布事件](1810515090228226.html)。 </li></ul></li><li>`COMMENT`：评论更新事件，包括 `comment.update` 事件。<ul><li>若想了解此类事件类型中事件的结构和有效负载示例，请查看[评论更新事件](1810515104773122.html)。</li></ul></li></ul> |
#| callback_url | string | 仅当该开发者应用存在对应的 Webhook 事件配置时返回本字段。<br><br>回调 URL。<br><br>例如，若返回中 `event_type` 显示为 `VIDEO` 且 未返回 `callback_url`，则代表您的开发者应用尚未创建帖子发布事件的 Webhook 配置。 |
#| item_list | string[] | 仅当 `event_type` 为 `COMMENT` 且开发者应用（`app_id`）配置了 `item_list` 时返回本字段。 <br><br>TikTok 帖子 ID 列表，用于获取这些帖子下评论的更新事件通知。|
示例
获取一个现有的 Webhook 配置
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"app_id": "{{app_id}}",
"callback_url": "{{callback_url}}",
"event_type": "VIDEO"
}
}
(/code)
获取一个空的 Webhook 配置
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"app_id": "{{app_id}}",
"event_type": "VIDEO"
}
}
(/code)