# 查询评价列表

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：getCcommentList

查询某小程序下面所有的评价。

## 1. 调用方式

### HTTPS 调用

```bash
GET https://api.weixin.qq.com/wxaapi/comment/mpcommentlist/get?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：151

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "startTime",
    "类型": "string",
    "必填": "是",
    "说明": "查询时间段的开始时间",
    "枚举": "-"
  },
  {
    "参数名": "endTime",
    "类型": "string",
    "必填": "是",
    "说明": "查询时间段的结束时间",
    "枚举": "-"
  },
  {
    "参数名": "filterType",
    "类型": "number",
    "必填": "否",
    "说明": "过滤的数据类型",
    "枚举": "枚举值"
  },
  {
    "参数名": "offset",
    "类型": "number",
    "必填": "否",
    "说明": "查询的偏移数（从offset开始计数拉取)，默认值为 0 代表首页拉取",
    "枚举": "-"
  },
  {
    "参数名": "limit",
    "类型": "number",
    "必填": "否",
    "说明": "查询每页中的数量，默认值为 8",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "string",
    "说明": "错误码"
  },
  {
    "参数名": "offset",
    "类型": "number",
    "说明": "查询的偏移数（从offset开始计数拉取)"
  },
  {
    "参数名": "total",
    "类型": "number",
    "说明": "评价总数"
  },
  {
    "参数名": "commentList",
    "类型": "objarray",
    "说明": "评价的列表"
  }
]
```

">

### Res.commentList(Array) `Object Payload`

评价的列表

```json
[
  {
    "参数名": "commentId",
    "类型": "string",
    "说明": "评价id"
  },
  {
    "参数名": "amount",
    "类型": "number",
    "说明": "金额,单位是分"
  },
  {
    "参数名": "orderId",
    "类型": "string",
    "说明": "订单id"
  },
  {
    "参数名": "createTime",
    "类型": "string",
    "说明": "创建时间，单位是秒"
  },
  {
    "参数名": "payTime",
    "类型": "string",
    "说明": "支付时间，单位是秒"
  },
  {
    "参数名": "wxPayId",
    "类型": "string",
    "说明": "微信支付交易单号，一般以420开头，是微信支付接口文档中的transaction_id"
  },
  {
    "参数名": "orderInfo",
    "类型": "object",
    "说明": "商家订单信息"
  },
  {
    "参数名": "userInfo",
    "类型": "object",
    "说明": "评价用户信息"
  },
  {
    "参数名": "bizInfo",
    "类型": "object",
    "说明": "商家小程序信息"
  },
  {
    "参数名": "score",
    "类型": "number",
    "说明": "评价分数（每100分对应1星）"
  },
  {
    "参数名": "content",
    "类型": "object",
    "说明": "评价内容"
  },
  {
    "参数名": "extInfo",
    "类型": "object",
    "说明": "评价额外信息"
  },
  {
    "参数名": "productInfo",
    "类型": "object",
    "说明": "评价商品信息"
  }
]
```

__orderInfo">

### Res.commentList(Array).orderInfo `Object Payload`

商家订单信息

```json
[
  {
    "参数名": "busiOrderId",
    "类型": "string",
    "说明": "商户单号：商户系统内部订单号，只能是数字、大小写字母_-*且在同一个商户号下唯一；是微信支付接口文档中的 out_trade_no"
  }
]
```

__userInfo">

### Res.commentList(Array).userInfo `Object Payload`

评价用户信息

```json
[
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "评价用户openid"
  },
  {
    "参数名": "headImg",
    "类型": "string",
    "说明": "评价用户的头像"
  },
  {
    "参数名": "nickName",
    "类型": "string",
    "说明": "评价用户的昵称"
  }
]
```

__bizInfo">

### Res.commentList(Array).bizInfo `Object Payload`

商家小程序信息

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "说明": "商家小程序的appid"
  },
  {
    "参数名": "headImg",
    "类型": "string",
    "说明": "商家小程序的头像"
  },
  {
    "参数名": "nickName",
    "类型": "string",
    "说明": "商家小程序的昵称"
  }
]
```

__content">

### Res.commentList(Array).content `Object Payload`

评价内容

```json
[
  {
    "参数名": "txt",
    "类型": "string",
    "说明": "评价内容"
  },
  {
    "参数名": "media",
    "类型": "objarray",
    "说明": "评价的媒体文件，如图片、视频, 视频跟图片只能存在一种，不同时存在，如果是图片可以有多张图，如果是视频只会有一个视频"
  }
]
```

__content__media">

### Res.commentList(Array).content.media `Object Payload`

评价的媒体文件，如图片、视频, 视频跟图片只能存在一种，不同时存在，如果是图片可以有多张图，如果是视频只会有一个视频

```json
[
  {
    "参数名": "img",
    "类型": "string",
    "说明": "图片cdn"
  },
  {
    "参数名": "thumbImg",
    "类型": "string",
    "说明": "缩略图cdn"
  },
  {
    "参数名": "video",
    "类型": "string",
    "说明": "视频资源cdn（有img的时候没有video）"
  },
  {
    "参数名": "videoCover",
    "类型": "string",
    "说明": "缩略图cdn（有img的时候没有videoCover）"
  },
  {
    "参数名": "videoDuration",
    "类型": "number",
    "说明": "视频时长，单位秒（有img的时候没有videoDuration）"
  }
]
```

__extInfo">

### Res.commentList(Array).extInfo `Object Payload`

评价额外信息

```json
[
  {
    "参数名": "isAlreadySendTmpl",
    "类型": "boolean",
    "说明": "是否已发过「差评客服会话」"
  }
]
```

__productInfo">

### Res.commentList(Array).productInfo `Object Payload`

评价商品信息

```json
[
  {
    "参数名": "productList",
    "类型": "objarray",
    "说明": "商品列表"
  }
]
```

__productInfo__productList">

### Res.commentList(Array).productInfo.productList `Object Payload`

商品列表

```json
[
  {
    "参数名": "name",
    "类型": "string",
    "说明": "商品名"
  },
  {
    "参数名": "picUrl",
    "类型": "string",
    "说明": "商品图片"
  }
]
```

## 4. 枚举信息

### Body.filterType `Enum`

过滤的数据类型

```json
[
  {
    "枚举值": "1",
    "描述": "全部差评，所有评价分数为1星、2星的评价"
  },
  {
    "枚举值": "2",
    "描述": "全部好评，所有评价分数为4星、5星的评价"
  },
  {
    "枚举值": "3",
    "描述": "差评待处理，所有未提交「和解挽回」的评价"
  },
  {
    "枚举值": "4",
    "描述": "开发者待回复，所有待开发者回复的评价"
  },
  {
    "枚举值": "5",
    "描述": "差评已改评"
  },
  {
    "枚举值": "6",
    "描述": "全部评价，所有好评、差评、中评（3星）部评价"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

```bash
GET  https://api.weixin.qq.com/wxaapi/comment/mpcommentlist/get?filterType=1&offset=0&limit=8&startTime=1588237130&endTime=1588237131&access_token=xxxx
```

返回示例

```json
{
  errcode: 0,
  success: true,
  commentList: [{
    commentId: "2797755680173111111",
    amount: 100,
    orderId: "payorder@_4200001761202302096311111111",
    payTime: "1675915718",
    wxPayId: "4200001761202302096311111111",
    orderInfo: {
      busiOrderId: 'xxxxxx'
    },
    userInfo: {
      openid: "xxxxxxxxxx",
      headImg: "http://wx.qlogo.cn/mmhead/xxxxxxxxxxx",
      nickName: "test"
    },
    bizInfo: {
        appid: "wx1234567890",
        headImg: "http://wx.qlogo.cn/mmhead/xxxxxxxxxxxx",
        nickName: "xxx"
    },
    score: 200, // 200分对应2星，每100分就是1星
    createTime: "1676351504",
    content: {
      media: [{img: 'http://xxx', thumbImg: 'http://xxx'}],
      txt: "一般吧 我总感觉这个成分很伤皮肤，用了之后一直很干燥，不是很喜欢这款产品"
    },
    extInfo: {
      isAlreadySendTmpl: false,
    },
    productInfo: {
      productList: [
        {
            name: "纸巾一张",
            picUrl: "https://xxxxxx",
        }
      ]
    }
  }],
  total: 3,
  offset: 0,
}
```

## 7. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-10403",
    "错误描述": "无权限操作该评价/评论/回复"
  },
  {
    "错误码": "-10008",
    "错误描述": "服务异常"
  },
  {
    "错误码": "-10007",
    "错误描述": "无权限调用接口"
  },
  {
    "错误码": "-10003",
    "错误描述": "参数不匹配"
  },
  {
    "错误码": "-10001",
    "错误描述": "参数异常"
  },
  {
    "错误码": "10000",
    "错误描述": "和解：不是差评/发送过模板消息；其它：参数异常"
  }
]
```

## 8. 适用范围

本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明，均不可调用。