QueryPushStatByMsg-阿里云帮助中心

Queries push statistics for a message.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mpush:QueryPushStatByMsg

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppKey	integer	Yes	The AppKey.	23267207
MessageId	integer	Yes	The ID of the pushed message. This ID is returned after a message is pushed. Note Push data is available the next day. You cannot query data for the current day.	510427

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	CF195C34-98FB-491A-98D7-19CBC1FA880B
PushStats	object
PushStat	array<object>	An array of PushStat objects. Each object contains the push statistics for a message or notification.
	object
MessageId	string	The message ID.	510427
DeletedCount	integer	The number of times the notification was cleared on devices.	10
OpenedCount	integer	The number of times the notification was opened on devices.	30
SmsReceiveSuccessCount	integer	(Optional) The number of text messages successfully received in a composite push.	0
SmsSkipCount	integer	(Optional) The number of text messages skipped in a composite push, for example, when no mobile number is bound.	0
SmsReceiveFailedCount	integer	(Optional) The number of text messages that were sent in a composite push but were not received.	0
SmsFailedCount	integer	(Optional) The number of text messages that failed to send in a composite push. This can happen if the service is not activated, authorization is denied, or parameters are invalid.	0
ReceivedCount	integer	The number of messages delivered to devices.	60
SentCount	integer	The number of messages sent from the push server.	100
SmsSentCount	integer	(Optional) The number of text messages sent in a composite push.	0
AcceptCount	integer	The number of pushes accepted by the push server.	120

Examples

Success response

JSON format

{
  "RequestId": "CF195C34-98FB-491A-98D7-19CBC1FA880B",
  "PushStats": {
    "PushStat": [
      {
        "MessageId": "510427",
        "DeletedCount": 10,
        "OpenedCount": 30,
        "SmsReceiveSuccessCount": 0,
        "SmsSkipCount": 0,
        "SmsReceiveFailedCount": 0,
        "SmsFailedCount": 0,
        "ReceivedCount": 60,
        "SentCount": 100,
        "SmsSentCount": 0,
        "AcceptCount": 120
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.