- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
评论列表
收藏
我的收藏接口说明
该接口用于获取视频评论列表。
注意事项
- 抖音的 OAuth API 以https://open.douyin.com/开头。
- 注意参数中 item_id 作为 url 参数时,必须 encode,只对 item_id 单独进行 encode
基本信息
名称 | 描述 |
---|---|
HTTP URL | https://open.douyin.com/api/apps/v1/item/list_comment/ |
HTTP Method | GET |
Scope | ma.item.comment |
权限要求 |
|
请求头
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
access-token | String | 是 | act.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ | |
content-type | String | 是 | application/json | 固定值"application/json" |
请求参数
Query
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
count | Int32 | 是 | 10 | 每页的数量,最大不超过50,最小不低于1 |
item_id | String | 是 | @8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w== | 视频id 该字段通过 /api/apps/v1/convert_video_id/video_id_to_open_item_id/ 接口返回的 data.convert_result._val 字段获取 |
open_id | String | 是 | ba253642-0590-40bc-9bdf-9a1334b94059 | 通过code2Session获取,用户唯一标志 该字段通过 /api/apps/v2/jscode2session 接口返回的 openid 字段获取 |
cursor | Int64 | 否 | 0 | 分页游标, 第一页请求cursor是0, response中会返回下一页请求用到的cursor, 同时response还会返回has_more来表明是否有更多的数据。 |
sort_type | String | 否 | time | 列表排序方式,不传默认按推荐序,可选值:time(时间逆序)、time_asc(时间顺序) |
请求示例
curl --location --request GET 'https://open.douyin.com/api/apps/v1/item_bc/list_comment/?open_id=ba253642-0590-40bc-9bdf-9a1334b94059&cursor=0&count=10&item_id=@8hxdhauTCMppanGnM4ltGM780mDqPP+KPpR0qQOmLVAXb/T060zdRmYqig357zEBq6CZRp4NVe6qLIJW/V/x1w==&sort_type=time' \
--header 'access-token: act.1d1021d2aee3d41fee2d2add43456badMFZnrhFhfWotu3Ecuiuka27L56lr' \
响应参数
Body
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
---|---|---|---|---|
data | Struct | 是 | ||
err_msg | String | 是 | "access_token无效" | 错误描述 |
err_no | Int32 | 是 | 28001003 | 错误码 |
log_id | String | 是 | "202405291440576E078D8757B9" | 日志id |
响应示例
正常响应示例
{
"data": {
"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"
}
]
},
"extra": {
"logid": "2020070614111601022506808001045D59",
"error_code": 0,
"description": "",
"sub_error_code": 0,
"sub_description": "",
"now": 1676268773
}
},
"err_no": 0,
"err_msg": "",
"log_id": "2020070614111601022506808001045D59"
}
异常响应示例
{
"err_no": 2100005,
"err_msg": "参数不合法",
"log_id": "20230213140437EEEDFAB3025AEA105C06",
"data": {
"extra": {
"logid": "20230213140437EEEDFAB3025AEA105C06",
"now": 1676268277507,
"error_code": 2100005,
"description": "参数不合法",
"sub_error_code": 0,
"sub_description": "count's value cannot greater than:20"
}
}
}
错误码
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 | 参数不合法 | 根据错误信息检查请求参数是否填写正常 |
该文档是否有帮助?
点击纠错