QuerySendStatistics-阿里云帮助中心

Queries message delivery statistics, including send dates, the number of successfully sent messages, and the number of received delivery receipts.

Operation description

If you query data over a long time range, the results are paginated. You can specify the page size and page number to navigate through the Delivery Logs.
You can also view delivery details by logging in to the Short Message Service console and navigating to the Business Statistics > Delivery Logs page.

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

dysms:QuerySendStatistics

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IsGlobe	integer	Yes	The destination scope of the messages. Valid values: 1: domestic messages. 2: international messages.	1
StartDate	string	Yes	The start date. The format is yyyyMMdd.	20201002
EndDate	string	Yes	The end date. The format is yyyyMMdd.	20201003
PageIndex	integer	Yes	The current page number.	1
PageSize	integer	Yes	The page size. Valid values: 1 to 50.	10
TemplateType	integer	No	The template type. Valid values: 0: verification code. 1: notification message. 2: promotional message. (Enterprise customers only) 3: international message. (Enterprise customers only) 7: digital message.	0
SignName	string	No	The signature.	阿里云平台

Response elements

Element	Type	Description	Example
	object	The body of the response.
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8DE990
Code	string	The response code. Valid values: OK: The request was successful. For other values, see Error codes.	OK
Message	string	The description of the status code.	OK
Data	object	The data returned.
TotalSize	integer	The total number of entries returned.	20
TargetList	array<object>	A list of delivery statistics.
	object
TotalCount	integer	The number of successfully sent messages (billable message count).	20
RespondedSuccessCount	integer	The number of messages with successful delivery receipts.	17
RespondedFailCount	integer	The number of messages with failed delivery receipts.	2
NoRespondedCount	integer	The number of messages with no delivery receipts.	1
SendDate	string	The date the messages were sent. Format: yyyyMMdd.	20201010

Examples

Success response

JSON format

{
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990\n",
  "Code": "OK",
  "Message": "OK",
  "Data": {
    "TotalSize": 20,
    "TargetList": [
      {
        "TotalCount": 20,
        "RespondedSuccessCount": 17,
        "RespondedFailCount": 2,
        "NoRespondedCount": 1,
        "SendDate": "20201010"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.