# Get message sending distribution data
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 name: getupstreammsgdist
This interface is used to obtain message sending distribution data
# 1. How to call
# HTTPS calls
POST https://api.weixin.qq.com/datacube/getupstreammsgdist?access_token=ACCESS_TOKEN
# Cloud Calls
Call method: officialAccount.datacube.getUpstreamMsgDist
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 this interface belongs is: 1
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 | Example | Introductions |
---|---|---|---|---|
begin_date | string | yes | 2014-12-07 | Start date (format: yyyy-MM-dd), span no more than 15 days |
end_date | string | yes | 2014-12-08 | End date |
# 3. Return Parameters
# Response Payload
Parameter Name | type | Introductions |
---|---|---|
list | object | List of data |
# Res.listObject Payload
List of data
Parameter Name | type | Introductions |
---|---|---|
ref_date | string | Date of data, between begin_date and end_date |
count_interval | number | The range in which the number of messages sent that day is distributed, 0 represents "0," 1 represents "1-5," 2 represents "6-10," and 3 represents "more than 10 times." |
msg_user | number | Number of users who sent messages upstream (to Official Account) |
# 4. Note
- The interface side database for Official Account data only stores data after December 1, 2014, does not query the date before that, and even if it does, it is untrusted as dirty data;
- Asking developers to save the data in their own databases after calling the interface to obtain it speeds up the next user's access and reduces unnecessary losses from the WeChat side of the interface call.
- To ensure the statistics and processing of Official Account data has been completed, please check the data of the previous day's Official Account message template after 8: 00 am every day.
# 5. Code examples
Example Requests
{
"begin_date": "2014-12-07",
"end_date": "2014-12-07"
}
Return an example
{
"list": [
{
"ref_date": "2014-12-07",
"count_interval": 1,
"msg_user": 246
}
]
}
# 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 |
61500 | date format error | Date format error |
61501 | date range error | Time span exceeds maximum limit |
61503 | data not ready please try later | No statistical processing was completed |
# 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;