抖音开放平台Logo
控制台

评论列表

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

获取抖音短视频评论列表

使用限制

注意参数中 item_id 作为 url 参数时,必须 encode,只对 item_id 单独进行 encode

基本信息

名称描述
HTTP URL
https://open.douyin.com/item/comment/list/
HTTP Method
GET
Scope
item.comment
权限要求

需要申请权限 需要用户授权 申请路径:移动、网站应用控制台-互动权限-管理视频评论

请求头

名称字段类型是否必填示例描述
access-tokenStringact.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
content-typeStringapplication/json
固定值"application/json"

请求参数

Query

名称字段类型是否必填示例描述
countInt3210
每页的数量,最大不超过50,最小不低于1
item_idString%409VwWjvGUTp9kKW%2Bma4huFs791GfuOPuEM5RzrQOuKFAUZ%2Ff660zdRmYqig357zEBoG9CZ3tmAj%2F%2Bzx3ynAUaVA%3D%3D

encode后的视频id,视频id 可以通过查询授权账号视频列表接口或接收评论回复事件获取

open_idStringba253642-0590-40bc-9bdf-9a1334b94059
通过/oauth/access_token/获取,用户唯一标志
cursorInt640
分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。
sort_typeStringtime
列表排序方式,不传默认按推荐序,可选值:time(时间逆序)、time_asc(时间顺序)

请求示例

curl --location --request GET 'https://open.douyin.com/item/comment/list/?open_id=43eae150-12eb-4035-8d40-3f9a2bfcdf4e&cursor=0&count=10&item_id=%409VwW0qOBUN9mJyD3bNxvGc791GLuPPGFOJx4rQOvLVAXbvj%2B60zdRmYqig357zEBXe9yX1kW9iI9RBd5IYhjRg%3D%3D&sort_type=time' \
--header 'Content-Type: application/json' \
--header 'access-token: act.0308b91b5f4858eedd25b827fa7ed69ewKUKlr2o6b9zZOe17m4iKlMyZjJB' 

响应参数

Body

名称字段类型是否必填示例描述

响应示例

正常响应示例

{
  "data": {
    "cursor": 1,
    "has_more": true,
    "list": [
      {
        "top": false,
        "comment_id": "@9VwW0qOBUN9mJyD3bNxvGc791G3uO/mLOZ10oQOjJ1EUafn460zdRmYqig357zEBidswyrkjAGx3+uVUd0cE4Q==",
        "comment_user_id": "43eae150-12eb-4035-8d40-3f9a2bfcdf4e",
        "content": "评论",
        "create_time": 1673507751,
        "digg_count": 0,
        "reply_comment_total": 0,
        "avatar": "https://uuue/ehdne",
        "nick_name": "xiaoming"
      }
    ],
    "error_code": 0,
    "description": ""
  },
  "extra": {
    "logid": "20230213141253084C5445E64119C50042",
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "now": 1676268773
  }
}

异常响应示例

{
  "err_no": 2100005,
  "err_msg": "参数不合法",
  "log_id": "20230213140437EEEDFAB3025AEA105C06",
  "data": {
    "error_code": 2100005,
    "description": "参数不合法"
  },
  "extra": {
    "logid": "20230213140437EEEDFAB3025AEA105C06",
    "now": 1676268277507,
    "error_code": 2100005,
    "description": "参数不合法",
    "sub_error_code": 0,
    "sub_description": "count's value cannot greater than:20"
  }
}

错误码

http状态码错误码错误码描述排查建议
2002100005

参数不合法

自查接口入参类型和取值是否符合规范

2002100004

系统繁忙,此时请开发者稍后再试

重试后不能解决,提开放平台oncall处理

20028001005
系统内部错误,请重试
请求重试,若依然无解请向平台提交反馈
20028001003
access_token无效
重新请求生成access_token
20028001008
access_token过期,请刷新或重新授权
重新请求生成access_token
20028001016
当前应用已被封禁或下线
clientKey被封禁或者下线
20028001006
网络调用错误,请重试
重试即可
20028001014
应用未授权任何能力
确认应用是否授权能力
20028001018
应用未获得该能力
开通相关能力
20028003017
quota已用完
联系平台处理
20028001019
应用该能力已被封禁
该能力被封禁,联系平台处理
20028001007
参数不合法
根据错误信息检查请求参数是否填写正常