通过 Webhook API 订阅 TikTok 账户的 Webhook 事件
本文介绍了通过 Webhook 获取 TikTok 帖子发布状态和 TikTok 账号评论更新相关通知的具体步骤。
简介
Webhook 是一种当 TikTok 平台内发生特定事件时触发的自动化 HTTP 回调，会将实时通知发送到您设置的回调 地址。采用此机制后，您可不必再持续使用 API 轮询来获取相关异步事件的信息，TikTok 会主动将事件数据发送到您的系统，且一旦相关事件数据生成就立即发送。这些通知以 JSON 格式通过 HTTPS POST 传递到您为开发者应用配置的回调 URL。您可以使用这些实时信息来更新您的系统或作为特定的业务流程的触发条件，确保您的应用程序与 TikTok 事件高效且及时地保持同步。
您可以通过订阅 TikTok 账号 Webhook，以便跟踪已发布内容的生命周期，并通过评论监控和响应用户互动。
前提条件
您已经拥有 TikTok API for Business 的使用权限。需确保已完成以下步骤： 1. 创建 TikTok For Business 账号。 2. 注册成为开发者。 3. 创建开发者应用。 4. 账号 API 授权。
-
若您想订阅帖子发布事件，需确保开发者应用已启用 TikTok Accounts > Business Content 权限。
-
若您想评论更新事件，需确保开发者应用已启用 TikTok Accounts > Business Comment 权限。
步骤
订阅帖子发布事件
若想为您的开发者应用订阅帖子发布事件，可使用/business/webhook/update/。在请求中传入开发者应用的 App ID（app_id）和密钥（secret），通过 callback_url 字段传入回调 URL，并将 event_type 设置为 VIDEO。
订阅示例
请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/business/webhook/update/' \
--header 'Content-Type: application/json' \
--data '{
"app_id": "{{app_id}}",
"secret": "{{secret}}",
"event_type": "VIDEO",
"callback_url": "{{callback_url}}"
}'
(/code)
返回
(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)
配置成功后，所指定的回调 URL 将收到通过 /business/video/publish/ 或 /business/photo/publish/ 发布的帖子相关状态变动的实时通知。若想了解此类事件类型中事件的结构和有效负载示例，请查看帖子发布事件。
订阅评论更新事件
若想为您的开发者应用订阅评论更新事件，可使用/business/webhook/update/。在请求中传入开发者应用的 App ID（app_id）和密钥（secret），通过 callback_url 字段传入回调 URL，并将 event_type 设置为 COMMENT。您可以同时通过可选参数 item_list 指定您想接收通知的具体 TikTok 帖子。
订阅示例
订阅所有帖子的评论更新事件
请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/business/webhook/update/' \
--header 'Content-Type: application/json' \
--data '{
"app_id": "{{app_id}}",
"secret": "{{secret}}",
"event_type": "COMMENT",
"callback_url": "{{callback_url}}"
}'
(/code)
返回
(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": "COMMENT"
}
}
(/code)
订阅指定帖子的评论更新事件
请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/business/webhook/update/' \
--header 'Content-Type: application/json' \
--data '{
"app_id": "{{app_id}}",
"secret": "{{secret}}",
"event_type": "COMMENT",
"callback_url": "{{callback_url}}",
"item_list": ["{{item_id}}","{{item_id}}"]
}'
(/code)
返回
(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": "COMMENT",
"item_list": [
"{{item_id}}",
"{{item_id}}"
]
}
}
(/code)
配置成功后，所指定的回调 URL 将在以下情况下收到实时通知：自有 TikTok 账号下的任一照片帖子或公开视频帖子下收到新评论或评论回复，原有评论或评论回复被删除，或原有评论或评论回复可见设置发生修改。若想了解此类事件类型中事件的结构和有效负载示例，请查看评论更新事件。