# View comment data for a specified article
Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide
Interface English name: listComment
This interface is used to view comments data for a specified article
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/cgi-bin/comment/list?access_token=ACCESS_TOKEN
# Cloud Calls
Call method: officialAccount.comment.list
The input and exit parameters are the same as the HTTPS call, which can be called in the cloud call documentation
# Third party invocation
This interface supports Third Party Platform generation business call.
The permission set id to which the interface belongs is: 7
When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.
# 2. Request parameters
# Query parametersQuery String parameters
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
access_token | string | yes | Interface invocation credentials, using access_token , authorizer_access_token |
# Request BodyRequest Payload
Parameter Name | type | Required to fill in | Introductions |
---|---|---|---|
msg_data_id | number | yes | The msg_data_id returned by the group |
index | number | no | Multi-text, used to specify the number of text, starting from 0, without the default return of the msg_data_id of the first text |
begin | number | yes | Start bit |
count | number | yes | Number of acquisitions (> 50 will be rejected) |
type | number | yes | Type = 0 General Review & Featured Review type = 1 General Review type = 2 Featured Review |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
errcode | number | Error code |
errmsg | string | Error Description |
comment | objarray | List of reviews |
total | number | Total Comments |
# Res.comment(Array)Object Payload
List of reviews
Parameter Name | type | Introductions |
---|---|---|
user_comment_id | number | User comment id |
create_time | number | Comment time |
content | string | Commentary Contents |
comment_type | number | Whether to select comments, 0 is not selected, 1 is true, that is selected |
openid | string | Openid, if a user comments with a non-WeChat identity, does not return openid |
reply | object | Response Information |
# Res.comment(Array).replyObject Payload
Response Information
Parameter Name | type | Introductions |
---|---|---|
content | string | Response content |
create_time | number | Time of recovery |
# 4. Note
There are no special considerations for this interface
# 5. Code examples
Example Requests
{
"msg_data_id" : MSG_DATA_ID,
"index" : 0,
"begin": 0,
"count": 40,
"type" : 0
}
Return an example
{
"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. Error code
The following is a list of error codes for this interface, other error codes can refer to General error codes
Error code | Error Description | Solutions |
---|---|---|
-1 | system error | The system is busy, so the developer is asked to try again in a few minutes. |
40001 | invalid credential access_token isinvalid or not latest | AppSecret error while getting access_token, or access_token is invalid.Developers should check that AppSecret is correct, or that they are calling interfaces for the appropriate Official Account |
45009 | reach max api daily quota limit | Calls exceed the day-level frequency limit. The clear_quota interface can be called to restore the call quota. |
88000 | without comment privilege | |
88010 | count range error. cout <= 0 or count > 50 |
# 7. Scope of application
Official Account | Service Account |
---|---|
Certification only | Certification only |
- Authentication only: means that only authenticated accounts are allowed to be invoked by the enterprise entity, and accounts that are not authenticated or do not support authentication cannot be invoked.
- Other account types that are not expressly stated may not be called on this interface without special instructions;