# Get Messages to Send Monthly Data

Debugging Tools

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: getupstreammsgmonth

This interface is used to obtain monthly data for message sending

The data annotation date for each month's cycle data is on the first day of the month (the 1st or Monday of the month). You need to call the interface after a certain month to get the data for that cycle. For example, if you call the Get monthly data interface on December 1 (November 1 - November 5) as (begin_date and end_date), you can get monthly data on November 1 (that is, monthly data for November).

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/datacube/getupstreammsgmonth?access_token=ACCESS_TOKEN

# Cloud Calls

  • Call method: officialAccount.datacube.getUpstreamMsgMonth

  • 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 NametypeRequired to fill inIntroductions
access_tokenstringyesInterface invocation credentials, using access_token , authorizer_access_token

# Request BodyRequest Payload

Parameter NametypeRequired to fill inExampleIntroductions
begin_datestringyes2014-12-07Start date (format: yyyy-MM-dd)
end_datestringyes2014-12-07End date (must be the same day)

# 3. Return Parameters

# Response Payload

Parameter NametypeIntroductions
listobjarrayList of data

# Res.list(Array)Object Payload

List of data

Parameter NametypeIntroductions
ref_datestringDate of data, between begin_date and end_date
msg_typenumberMessage type represents the following meanings: 1 Represents text 2 Represents pictures 3 Represents voice 4 Represents video 6 Represents a third party application message (link message)
msg_usernumberNumber of users who sent messages upstream (to Official Account)
msg_countnumberTotal number of messages sent upstream

# 4. Note

There are no special considerations for this interface

# 5. Code examples

Example Requests

{
  "begin_date": "2014-12-07",
  "end_date": "2014-12-08"
}

Return an example

{
  "list": [
    {
      "ref_date": "2014-12-07",
      "msg_type": 1,
      "msg_user": 282,
      "msg_count": 817
    }
  ]
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

Error codeError DescriptionSolutions
40001invalid credential  access_token isinvalid or not latestAppSecret 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

# 7. Scope of application

How this interface can be invoked under different account types:
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;