评价列表
查询平台营员/会员对营种的已发布评价列表,支持按评价时间、营种、营期、评价星级、售卖门店筛选,返回评价时间、营种、营期、评价内容、星级、图片等信息,分页输出。
信息
数据范围:仅返回已发布展示的评价——待审核、已隐藏的评价不包含;系统自动生成的默认好评(内容为"此用户没有填写评价"的记录)也不包含。以上范围规则不可通过参数调整。
GET/api/getCommentList
核心语义
- 只读查询:返回符合条件的评价列表,按评价先后倒序(新的在前),分页输出。
- 筛选参数全部可选:不传任何筛选条件即查询全量已发布评价(按分页)。
- 星级精确匹配:
star取值0~5、支持半星(如4.5),按精确星级匹配,不是"≥ 该星级"。 - 关联查询开关:
relation=1时按pid筛选可一并返回与该营种互相关联的其他营种的评价(关联关系由平台运营侧配置);relation=0(默认)仅返回该营种自身的评价。relation仅传pid时有意义。 - 部分评价没有营期:评价只有挂在具体订单或满意度调查上才能对应到营期;运营侧手工录入、批量导入的评价没有营期,此时
period_id=0、period_name="",属正常数据,请做好兼容。 - 契约:
code恒为0;成功时msg为空;失败时msg非空、data为空数组。业务成功与否以msg判定。
请求参数
| 名称 | 类型 | 描述 | 是否必填 | 默认值 | 备注 |
|---|---|---|---|---|---|
| token | String | 身份校验令牌 | 必填 | - | 由 获取访问令牌 获得 |
| start_time | String | 评价提交时间筛选起点 | 选填 | 不限 | 支持时间戳或日期字符串(如 2026-07-01) |
| end_time | String | 评价提交时间筛选终点 | 选填 | 不限 | 支持时间戳或日期字符串;仅传日期时默认含当天全天 |
| pid | Number | 营种 ID | 选填 | 不筛选 | 见 获取营种列表 |
| period_id | Number | 营期 ID | 选填 | 不筛选 | 见 获取营期日期;无营期的评价不会被此条件命中 |
| star | Number | 评价星级 | 选填 | 不筛选 | 取值 0~5,支持半星(如 4.5),按精确星级匹配 |
| store_id | Number | 售卖门店 ID | 选填 | 不筛选 | 见 获取门店清单;无营期(未关联订单)的评价不会被此条件命中 |
| relation | Number | 是否开启关联查询 | 选填 | 0 | 0:按 pid 筛选时仅返回该营种自身评价;1:一并返回与它互相关联的其他营种的评价。仅传 pid 时有意义 |
| pageNum | Number | 页码 | 选填 | 1 | 从 1 开始 |
| pageSize | Number | 每页条数 | 选填 | 10 | 最大 100 |
CURL
V1(GET)
curl --location --request GET 'https://open.xinduobang.cn/api/getCommentList?token=YOUR_TOKEN&pid=620&pageNum=1&pageSize=10'
V1(POST)
curl --location --request POST 'https://open.xinduobang.cn/api/getCommentList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'token=YOUR_TOKEN' \
--data-urlencode 'pid=620' \
--data-urlencode 'star=4.5' \
--data-urlencode 'pageNum=1' \
--data-urlencode 'pageSize=10'
V2(appid 为 V2 版本)
curl --location --request POST 'https://open.xinduobang.cn/api/getCommentList' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Timestamp: 1770000000' \
--header 'X-Nonce: 3f9c1a7b2e6d4058' \
--header 'X-Signature: <computed_hmac_sha256>' \
--data-urlencode 'token=YOUR_TOKEN' \
--data-urlencode 'pid=620' \
--data-urlencode 'pageNum=1' \
--data-urlencode 'pageSize=10'
信息
V2 签名算法及 X-Signature 计算方式见 V2 接入示例。
成功响应
按营种查询
{
"code": 0,
"msg": "",
"data": {
"total": 1,
"pageNum": 1,
"pageSize": 1,
"list": [
{
"createtime": "2022-04-25 16:24:34",
"pid": 620,
"course_name": "示例营种A",
"period_id": 4005,
"period_name": "2022/04/20-2022/04/22",
"content": "评价内容示例",
"star": 5,
"picstr": []
}
]
}
}
开启关联查询(relation=1)
营种 18507 自身没有已发布评价,但平台侧配置了它与营种 759 关联,开启后返回关联营种的评价:
GET /api/getCommentList?pid=18507&relation=1 → total=4,返回营种 759 的评价
GET /api/getCommentList?pid=18507 → total=0(未开启关联,只查自身)
{
"code": 0,
"msg": "",
"data": {
"total": 4,
"pageNum": 1,
"pageSize": 1,
"list": [
{
"createtime": "2023-02-16 15:53:30",
"pid": 759,
"course_name": "示例营种B",
"period_id": 4684,
"period_name": "2023/01/29-2023/02/01",
"content": "评价内容示例",
"star": 5,
"picstr": []
}
]
}
}
带图片的评价
{
"code": 0,
"msg": "",
"data": {
"total": 1,
"pageNum": 1,
"pageSize": 10,
"list": [
{
"createtime": "2024-08-12 15:33:33",
"pid": 1732,
"course_name": "示例营种C",
"period_id": 0,
"period_name": "",
"content": "评价内容示例",
"star": 2,
"picstr": [
"https://{文件域名}/images/xxx-1.jpeg",
"https://{文件域名}/images/xxx-2.jpeg"
]
}
]
}
}
data 字段说明
| 键 | 类型 | 说明 |
|---|---|---|
| total | Number | 符合条件的评价总条数 |
| pageNum | Number | 当前页码 |
| pageSize | Number | 每页条数 |
| list | Array | 评价列表,按评价先后倒序(新的在前) |
list[] 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| createtime | String | 评价时间,格式 YYYY-MM-DD HH:mm:ss |
| pid | Number | 被评价的营种 ID(该评价未关联营种时为 0) |
| course_name | String | 被评价的营种名称 |
| period_id | Number | 被评价的营期 ID(无法关联到营期时为 0,见注意事项) |
| period_name | String | 营期时间,格式 YYYY/MM/DD-YYYY/MM/DD,如 2022/04/20-2022/04/22;无法关联时为空字符串 |
| content | String | 评价内容(文本) |
| star | Number | 评价星级,1~5,可能出现半星(如 4.5) |
| picstr | Array | 评价图片 URL 列表(顺序与用户上传顺序一致),可直接访问;无图时为空数组 [] |
注意事项
- 部分评价没有营期:运营侧手工录入、批量导入的评价
period_id=0、period_name="",属正常数据,请做好兼容。 - 营期 / 门店筛选的生效范围:
period_id、store_id依赖评价与订单的关联关系,无营期的评价不会被这两个条件命中。 relation只影响营种维度的返回范围,不影响评价营期字段的返回——任何模式下只要评价能关联到营期都会返回。
失败响应
契约下
code恒为0,失败通过非空msg与空data标识。
{ "code": 0, "msg": "star取值范围为0~5", "data": [] }
{ "code": 0, "msg": "时间格式错误", "data": [] }
| 错误文案 | 说明 |
|---|---|
star取值范围为0~5 | star 超出 0~5 范围 |
时间格式错误 | start_time / end_time 无法解析为时间戳或日期字符串 |
相关接口
变更记录
| 日期 | 变更 |
|---|---|
| 2026-11-03 | 首次发布:/api/getCommentList(GET/POST,筛选参数全部可选),透传上游 /Tools/getCommentList。查询营种已发布评价列表,支持评价时间、营种、营期、星级(含半星、精确匹配)、售卖门店筛选;relation=1 可一并返回关联营种的评价;仅返回已发布展示的评价,不含待审核/已隐藏/系统默认好评 |