获取评价数据
收藏
我的收藏使用限制
获取评价数据的商品(课程库)等,必须是存在的,且已经产生过评价。
该接口当前支持的行业:泛知识。
接口说明
该接口用于开发者从服务端获取评价数据,是一个分页接口。
基本信息
基本信息 | |
HTTP URL | https://developer.toutiao.com/api/comment/open/get |
HTTP Method | POST |
权限要求 | access_token 鉴权 |
请求头
名称 | 类型 | 是否必填 | 备注 | 示例 |
Content-Type | string | 是 | 请求的 MIME 类型,统一为 application/json | "application/json" |
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例 |
access_token | string | 是 | 接口调用凭证 | "0801121846735352506a356a67395167574457583155554e67654321" |
app_id | string | 是 | 小程序 ID | "tt12fd9846e1023401" |
origin_id | string | 是 | 商品 ID(课程 ID) | "7089056237526450211" |
biz_line | number | 是 | 业务线 ID:
| 2 |
offset | number | 是 | 分页的偏移量,从 0 开始 | 0 |
count | number | 是 | 每页数据量,范围 1~20,不在该范围的值请求时会报错 | 20 |
请求示例
{ "origin_id": "7089056237526450211", "offset": 0, "count": 10, "biz_line": 2, "app_id": "ttcfdbb96650e33350", "access_token": "08011218467778704661796571716c3449565530496c374a4a673d3d" }
响应参数
名称 | 类型 | 描述 | 示例值 |
err_no | number | 错误码,0 为成功 | 0 |
err_tips | string | 错误内容 | "success" |
log_id | string | 日志 ID | "202208182057270101742350380046FFCC" |
data | Object | 评论具体数据 | 见下方响应 |
data 字段
名称 | 类型 | 描述 | 示例值 |
has_more | bool | 是否还有更多数据 | true |
count | number | 总记录条数 | 100 |
comment_list | object[] | 评论详细信息字段 | 见下方响应 |
评论详细信息字段
名称 | 类型 | 描述 | 示例值 |
create_time | string | 评价时间 | "2022-08-16 17:03:10 +0800 CST" |
group_id | number | 评价主体id | 7127552400897884972 |
id | number | 评价id | 7132351211985978156 |
imge_urls | []string | 评价图片链接列表 | [ "test_img_url" ] |
ratings | string | 评价分数 | "{\"course\":4,\"has_pic\":1,\"has_text\":1,\"overall\":1,\"quality\":1,\"service\":2,\"tag_course\":3,\"tag_overall\":1,\"tag_quality\":1,\"tag_service\":1}" |
status | number | 评价状态枚举:
| 1 |
text | string | 评价内容 | "这是一条评价文本" |
user | object | 用户信息字段 | 见下方 用户信息字段 |
devloper_reply_comments | []object | 开发回复内容 | 数组的每个对象结构 见下方 开发者回复字段 |
用户信息字段
名称 | 类型 | 描述 | 示例值 |
avatar_url | string | 用户头像 | "test_avatar_url" |
scree_name | string | 用户昵称 | "b**" |
is_anonymous | bool | 是否匿名 | true |
开发者回复字段
名称 | 类型 | 描述 | 示例值 |
parent_comment_id | string | 回复的评论ID | "7127552400897884972" |
reply_id | string | 回复ID | "7127552411897884973" |
text | string | 开发者回复内容 | "感谢反馈,我们将尽快解决您的问题" |
create_time | number | 回复时间戳(秒) | 1718187178 |
响应示例
正常示例
{ "data": { "comment_list": [ { "create_time": "2022-08-16 17:03:10 +0800 CST", "group_id": 7127552400897884972, "id": 7132351211985978156, "imge_urls": [ "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/df334ebf9a584658804ee6d78bd2eae4~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=GTJeRCoH5pz6TcpgaiQ8ScFsdJ0%3D", "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/1e7d8ce45f194c4e8f2548d4ea07dfac~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=XMmGLWBMAuJRF6HKLF9HydEPYqc%3D", "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/b71f4464b34e446b9a15988b542f9979~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=kJHU7ojT9uQDDgMb5Elad6lzUPQ%3D" ], "ratings": "{\"course\":4,\"has_pic\":1,\"has_text\":1,\"overall\":1,\"quality\":1,\"service\":2,\"tag_course\":3,\"tag_overall\":1,\"tag_quality\":1,\"tag_service\":1}", "status": 1, "text": "这是一条评价文本", "user": { "avatar_url": "https://p-boe.byted.org/aweme/1080x1080/aweme-avatar/tos-boe-o-0000_7059230b38ee45e7bc9b1aca1e47fa60.jpeg", "is_anonymous": false, "scree_name": "b**" }, "devloper_reply_comments": [{ "parent_comment_id": "7127552400897884972", "reply_id": "7127552411897884973", "text": "感谢反馈,我们将尽快解决您的问题", "create_time": 1718187178 }] }, { "create_time": "2022-08-16 14:43:33 +0800 CST", "group_id": 7127552400897884972, "id": 7132306540686689068, "imge_urls": [ "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/a6f9fdbef85e46a38e5f9658d944c371~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=NCAfjxrg6xkwk0fR5Ce3bqZLsVg%3D", "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/bbbb239d795d43caa9e6344c50eea30d~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=8GvyWdR1m%2FodD%2Bva%2F5bRyLlrkYo%3D", "http://p-boe-sign.bytedance.net/tos-boe-i-jj8k1kottx/5b947380375248c2be0a720d4a7dea86~tplv-giyy2m8f28-jpg.image?x-orig-authkey=boeorigin&x-orig-expires=1661848408&x-orig-sign=mxnJyKFF9KAKC6biMJKT1iMU8aw%3D" ], "ratings": "{\"has_pic\":1,\"has_text\":1}", "status": 1, "text": "这是一条评价文本2", "user": { "avatar_url": "https://p-boe.byted.org/aweme/1080x1080/aweme-avatar/tos-boe-o-0000_7059230b38ee45e7bc9b1aca1e47fa60.jpeg", "is_anonymous": false, "scree_name": "b**" } } ], "count": 57, "has_more": true }, "err_msg": "success", "err_no": 0, "log_id": "2022083015421701022514515206E967D6" }
异常示例
{ "err_msg": "无效的AccessToken", "err_no": 11004, "log_id": "2022083015301801022514515206E6F443" }
错误码
HTTP 状态码 | 错误码 | 描述 | 排查建议 |
200 | 0 | 请求成功 | 正确 |
200 | 10000 | 参数错误 | 请检查请求参数是否正确 |
200 | 13000 | 系统错误 | 参考err_msg排查问题 |
200 | 30020 | 当前商品没有评价数据 | 商品没有评价数据 |