# 查看指定文章的评论数据

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

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

接口英文名：listComment

本接口用于查看指定文章的评论数据

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/comment/list?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：officialAccount.comment.list

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [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](/doc/service/api/base/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "msg_data_id",
    "类型": "number",
    "必填": "是",
    "说明": "群发返回的msg_data_id"
  },
  {
    "参数名": "index",
    "类型": "number",
    "必填": "否",
    "说明": "多图文时，用来指定第几篇图文，从0开始，不带默认返回该msg_data_id的第一篇图文"
  },
  {
    "参数名": "begin",
    "类型": "number",
    "必填": "是",
    "说明": "起始位置"
  },
  {
    "参数名": "count",
    "类型": "number",
    "必填": "是",
    "说明": "获取数目（>=50会被拒绝）"
  },
  {
    "参数名": "type",
    "类型": "number",
    "必填": "是",
    "说明": "type=0 普通评论&精选评论 type=1 普通评论 type=2 精选评论"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误描述"
  },
  {
    "参数名": "comment",
    "类型": "objarray",
    "说明": "评论列表"
  },
  {
    "参数名": "total",
    "类型": "number",
    "说明": "评论总数"
  }
]
```

">

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

评论列表

```json
[
  {
    "参数名": "user_comment_id",
    "类型": "number",
    "说明": "用户评论id"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "评论时间"
  },
  {
    "参数名": "content",
    "类型": "string",
    "说明": "评论内容"
  },
  {
    "参数名": "comment_type",
    "类型": "number",
    "说明": "是否精选评论，0为即非精选，1为true，即精选"
  },
  {
    "参数名": "openid",
    "类型": "string",
    "说明": "openid，用户如果用非微信身份评论，不返回openid"
  },
  {
    "参数名": "reply",
    "类型": "object",
    "说明": "回复信息"
  }
]
```

__reply">

### Res.comment(Array).reply `Object Payload`

回复信息

```json
[
  {
    "参数名": "content",
    "类型": "string",
    "说明": "回复内容"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "回复时间"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

``` json
{ 
  "msg_data_id" : MSG_DATA_ID,
  "index" : 0,
  "begin": 0,
  "count": 40,
  "type" : 0
} 
```

返回示例

``` json
{ 
    "errcode": 0, 
    "errmsg": "ok", 
    "total": TOTAL,
    "comment": [{ 
        "user_comment_id" : USER_COMMENT_ID,
        "openid": OPENID                         //openid，用户如果用非微信身份评论，不返回openid
        "create_time": CREATE_TIME,
        "content": CONTENT,
        "comment_type": IS_ELECTED,
        "reply": { 
                "content": CONTENT,
                "create_time" : CREATE_TIME
            } 
        }] 
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "45009",
    "错误描述": "reach max api daily quota limit",
    "解决方案": "调用超过天级别频率限制。可调用clear_quota接口恢复调用额度。"
  },
  {
    "错误码": "88000",
    "错误描述": "without comment privilege",
    "解决方案": ""
  },
  {
    "错误码": "88010",
    "错误描述": "count range error. cout  50",
    "解决方案": ""
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "公众号": "仅认证",
    "服务号": "仅认证"
  }
]
```

- 仅认证：表示仅允许企业主体已认证账号调用，未认证或不支持认证的账号无法调用。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。