置顶评论__抖音开放平台

接口说明

该接口用于置顶一条评论。

使用限制

只允许对作者的一级评论进行置顶
一个视频只能置顶一条评论

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/apps/v1/item/top_comment/
HTTP Method	POST
Scope	ma.item.comment
权限要求	需要申请权限。需通过控制台-小程序应用下，进入“能力-用户数据能力-抖音账号数据”，申请"视频评论数据"能力权限抖音用户通过小程序tt.showDouyinOpenAuth完成授权，调用/oauth/access_token/ 生成token。示例：act.xxx

请求头

名称	字段类型	是否必填	示例	描述
access-token	String	是	act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ	调用https://open.douyin.com/oauth/access_token/生成的token
content-type	String	是	application/json	固定值"application/json"

请求参数

Query

名称	字段类型	是否必填	示例	描述
open_id	String	是	ba253642-0590-40bc-9bdf-9a1334b94059	通过code2Session获取，用户唯一标志该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取

Body

名称	字段类型	是否必填	示例	描述
comment_id	String	是	@9VwW0qOBUN9mJyD3bNxvGc7912bvP/mEMpJwqwykKlEaZvn860zdRmYqig357zEB6/24MEvXsIUhf+t3F/Gw6w==	评论id，调用item/comment/list接口获取需要置顶的评论comment_id
item_id	String	是	@8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4JHe6qLIJW/V/x1w==	视频id，调用videoid转换itemid接口获取视频item_id 该字段通过 /api/apps/v1/convert_video_id/video_id_to_open_item_id/ 接口返回的 data.convert_result._val 字段获取
top	Bool	是	true	true: 置顶, false: 取消置顶

请求示例

curl --location 'https://open.douyin.com/item/comment/top/?open_id=ec1aa301-641b-4fcd-970c-8b0804c6dd01' \
--header 'Content-Type: application/json' \
--header 'access-token: act.fac8456b5a6b0e0ecc8969854ad625162zmeHsIe6wIqJr1Xw5YBXSMk4pcW' \
--data-raw '{
    "item_id": "@9VwW0qOBUN9mJyD3bNxvGc791GzhPfGHO5F2qQuuL1EUZvX560zdRmYqig357zEBZyxgSWZE1UdFqva5Pf296w==",
    "comment_id": "@9VwW0qOBUN9mJyD3bNxvGc7912bvP/mEMpJwqwykKlEaZvn860zdRmYqig357zEB6/24MEvXsIUhf+t3F/Gw6w==",
    "top": true
}'

响应参数

Body

名称	字段类型	是否必填	示例	描述
data	Struct	是
err_msg	String	是	"access_token无效"	错误描述
err_no	Int32	是	28001003	错误码
log_id	String	是	"202405291440576E078D8757B9"	日志id

响应示例

正常响应示例

{
  "data": {
    "nick_name": "7w899",
    "avatar": "xxxxxxxxx",
    "extra": {
      "error_code": 0,
      "description": "",
      "sub_error_code": 0,
      "sub_description": "",
      "now": 1594015876138,
      "log_id": "2020070614111601022506808001045D59"
    }
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "2020070614111601022506808001045D59"
}

异常响应示例

{
  "data": {
    "extra": {
      "error_code": 2100005,
      "description": "Parameter error",
      "sub_error_code": 0,
      "sub_description": "",
      "now": 1594015876138,
      "log_id": "2020070614111601022506808001045D59"
    }
  },
  "err_no": 0,
  "err_msg": "",
  "log_id": "2020070614111601022506808001045D59"
}

错误码

http状态码	错误码	错误码描述	排查建议
200	28001005	系统内部错误，请重试	请求重试，若依然无解请向平台提交反馈
200	28001003	access_token无效	重新请求生成access_token
200	28001008	access_token过期,请刷新或重新授权	重新请求生成access_token
200	28001016	当前应用已被封禁或下线	clientKey被封禁或者下线
200	28001006	网络调用错误，请重试	重试即可
200	28001014	应用未授权任何能力	确认应用是否授权能力
200	28001018	应用未获得该能力	开通相关能力
200	28003017	quota已用完	联系平台处理
200	28001019	应用该能力已被封禁	该能力被封禁，联系平台处理
200	28001007	参数不合法	根据错误信息检查请求参数是否填写正常

置顶评论在线调试

接口说明

使用限制

基本信息

请求头

请求参数

Query

Body

请求示例

响应参数

Body

响应示例

正常响应示例

异常响应示例

错误码

置顶评论