隐藏/取消隐藏自有视频的评论

您可以使用本接口隐藏或取消隐藏自有TikTok 账号所发布原生视频的现有评论。

注意
- 取消隐藏评论可能由于审核操作、用户隐私设置或其他系统层级的过滤机制而不会生效。在这些情况下，评论将保持隐藏状态。要验证评论当前的可见性状态，您可以订阅相关的评论 webhook 事件，或者调用 /business/comment/list/ 接口获取评论的状态（status）。 - 评论 webhook 事件 comment.update 使您能够在自有 TikTok 账号下的任一公开视频下原有评论或评论回复被隐藏或取消隐藏的五分钟内收到通知。若想订阅评论 webhook ，请查看订阅评论更新事件。

v1.2与v1.3版本对比

以下表格概括了 v1.2与v1.3接口的变化。

|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/business/comments/hide/| /v1.3/business/comment/hide/|

请求

地址 https://business-api.tiktok.com/open_api/v1.3/business/comment/hide/

方法 POST

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|经 TikTok 创作者授权的访问令牌。<br>若想获取访问令牌，需使用[/tt_user/oauth2/token/](https://business-api.tiktok.com/portal/docs?id=1738084387220481#item-link-获取访问令牌)接口。|
|Content-Type {必填}|string|请求信息类型。<br>允许格式：`application/json`。|

参数

请将下列参数作为查询字符串进行传递。

|字段{25%}|类型{10%}|参数位置{10%}|描述{55%}|
|--- |--- |--- |--- |
|business_id {必填}| string |Body| TikTok 账户的应用唯一识别ID。<br>您需将[/tt_user/oauth2/token/](https://business-api.tiktok.com/portal/docs?id=1738084387220481#item-link-获取访问令牌)接口返回的`open_id`字段值传给本字段。|
|comment_id {必填}|string| Body|自有 TikTok 视频评论的唯一标识符，隐藏/取消隐藏的对象。可通过[/business/comment/list/](https://ads.tiktok.com/marketing_api/docs?id=1760232109619202) 接口的<code>comment_id</code>字段获取所列的各个评论的 ID。|
|video_id {必填}|string| Body|自有 TikTok 视频的唯一标识符。可通过[/business/video/list/](https://ads.tiktok.com/marketing_api/docs?id=1762228421622786) 接口的<code>item_id</code>字段获取。|
| action {必填}|string| Body|要对评论进行的特定操作 - 隐藏或取消隐藏。<br><br><strong>枚举值</strong>：<ul><li>`HIDE`</li><li>`UNHIDE`</li></ul><br><strong>示例</strong>：`HIDE`|

示例

(code curl http)
curl --location  --request POST 'https://business-api.tiktok.com/open_api/v1.3/business/comment/hide/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Content-Type: application/json' \
--data '{
    "business_id" : "{{business_id}}",
    "comment_id" : "{{comment_id}}",
    "video_id": "{{video_id}}",
    "action": "HIDE"
}'
(/code)

Header

这些header很重要，可用于记录问题报告和故障排查信息。下表列出了部分返回的header。

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| Date | string | 收到返回时的(GMT)日期和时间 。 <br><strong>示例</strong>：Fri, 13 Aug 2021 08:04:42 GMT |
| X-Tt-Logid | string | 接口请求的唯一标识符。|

Body

|字段{30%}|类型{15%}|描述{55%}|
|-|-|-|
| request_id | string | 接口请求的唯一标识符。<br><br>请记录此字段，用于所有接口请求。此字段对于问题报告和故障排查十分重要。 |
| code | integer | 返回码。完整返回码列表及描述，可查看[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message| string | 返回信息。更多信息可查看[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
| data | object | 返回数据。<br>操作成功时返回空对象：`{}`。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
  "code": 0,
  "message": "Ok",
  "request_id": "20210817034316010245031056097316BA",
  "data": {}
}
(/code)