发送或撤销 TTO 视频关联请求
你可以使用本接口发送将达人公开视频关联到 TikTok One(TTO)Creator Marketplace 营销活动的请求,或撤销该请求。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/link/
方法 POST
Header
|字段{32%}|类型{15%}|描述{53%}|
|---|---|---|
|Access-Token {必填}|string|由 TTO Creator Marketplace 账户授权的访问令牌。 <br>详情参见[从 TTO Creator Marketplace 账户获取授权和访问令牌](https://business-api.tiktok.com/portal/docs/obtain-authorization-and-authentication-from-a-tto-creator-marketplace-account/v1.3)。|
|Content-Type {必填}|string|请求消息类型。<br>允许的格式:`application/json`。|
参数
|字段{32%}|类型{15%}|描述{53%}|
|--- |--- |--- |
| tto_tcm_account_id {必填} | string | TikTok One Creator Marketplace 账户的 ID。<br><br>要获取您通过访问令牌 `Access-Token` 可访问的账户 ID,使用接口 [/tto/oauth2/tcm/](1815693478150146.html)。 |
| campaign_id {必填} | string | 已有的 TTO Creator Marketplace 营销活动 ID。<br><br>要获取 TTO Creator Marketplace 营销活动列表,可使用接口 [/tto/tcm/campaign/](1815693562720258.html)。 |
| video_id {必填} | string | 要关联到营销活动的达人公开视频 ID。<br><br>要获取达人视频列表,使用接口 [/tcm/creator/authorized/video/list/](https://business-api.tiktok.com/portal/docs?id=1735827480228865)。<br><br><p><span style="color:darkred"><b>注意</b></span>:<ul><li>已关联至其它 TikTok Creator Marketplace 或 TTO Creator Marketplace 营销活动的视频不支持关联。</li><li>视频达人需已被邀请加入该营销活动。</li></ul> |
| action {必填} | string | 操作类型。<br><br>枚举值:<ul><li>`LINK`:向达人发送请求,将视频关联到营销活动。若请求已发送,系统会向达人发送提醒通知。<ul><li>发送关联请求后,需等待 24 小时后方可再次发送提醒通知,否则会报错。</li><li>每个关联请求最多可发送两次提醒通知。</li></ul></li><li>`REVOKE`:撤销关联请求。<ul><li>仅当达人未接受或拒绝请求时可使用此操作。</li><li>每个关联请求仅可撤销一次。</li></ul></li></ul> |
示例
发送关联请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/link/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"tto_tcm_account_id": "{{tto_tcm_account_id}}",
"video_id": "{{video_id}}",
"campaign_id": "{{campaign_id}}",
"action": "LINK"
}'
(/code)
撤销关联请求
(code curl http)
curl --location --request POST 'https://business-api.tiktok.com/open_api/v1.3/tto/tcm/campaign/link/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
"tto_tcm_account_id": "{{tto_tcm_account_id}}",
"video_id": "{{video_id}}",
"campaign_id": "{{campaign_id}}",
"action": "REVOKE"
}'
(/code)
返回
|字段{32%}|类型{15%}|描述{53%}|
|---|---|---|
|code |number|返回码。完整返回码列表及描述参见 [附录 - 返回码](1737172488964097.html)。|
|message|string|返回信息。更多信息参见 [附录 - 返回码](1737172488964097.html)。|
|request_id |string|请求的日志 ID,唯一标识一个请求。|
|data |object|返回数据。|
#| video_id | string | 要关联到营销活动的达人视频 ID。 |
#| status | string | 请求状态。<br><br>枚举值:<ul><li>`IN_REVIEW`:已发送给达人,等待达人接受或拒绝。</li><li>`REVOKE`:已撤销。</li></ul>|
#| last_reminded_timestamp | string | 最后一次向达人发送关联请求或提醒通知的时间,采用 ISO-8601 格式。<br><br>示例:`2025-01-01T00:00:01Z`。|
#| number_of_requests | integer | 您已为该视频发送的关联请求次数。<br><br>示例:1。|
#| campaign_type | string | TTO Creator Marketplace 营销活动的类型。<br><br>枚举值:<ul><li>`CAMPAIGN`:带有营销活动级别邀请链接的营销活动。</li><li>`BRAND_LINK`:带有品牌级别邀请链接的营销活动。</li></ul>|
示例
发送关联请求
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"last_reminded_timestamp": "2025-02-07T21:44:56Z",
"number_of_requests": 1,
"status": "IN_REVIEW",
"campaign_type": "CAMPAIGN",
"video_id": "{{video_id}}"
}
}
(/code)
撤销关联请求
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"last_reminded_timestamp": "2025-02-07T21:12:44Z",
"number_of_requests": 1,
"status": "REVOKE",
"campaign_type": "CAMPAIGN",
"video_id": "{{video_id}}"
}
}
(/code)