DocsICP FilingConsole
Documentation

QuerySendStatistics

Updated at:
Copy as MD
Product
My Favorites

Queries the details of SMS sending statistics, including the sending time, the number of successfully sent messages, and the number of received receipts.

Operation description

  • If the selected time range is long, you can view the records by page. Specify the number of SMS details to display on each page and the page number to view the sending records by page.

  • You can log on to the Short Message Service console and choose Business Statistics > Sending Records to query the sending details.

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 None

Request parameters

Parameter

Type

Required

Description

Example
IsGlobe

integer

Yes

The scope of SMS sending. Valid values:

  • 1: Domestic SMS sending records.

  • 2: International/Hong Kong, Macao, and Taiwan SMS sending records.

1
StartDate

string

Yes

The start date. Format: yyyyMMdd.

20201002
EndDate

string

Yes

The end date. Format: yyyyMMdd.

20201003
PageIndex

integer

Yes

The current page number.

1
PageSize

integer

Yes

The number of entries to return on each page. Valid values: 1 to 50.

10
TemplateType

integer

No

The templatetype. Valid values:

  • 0: Authenticate code.

  • 1: Notification message.

  • 2: Promotional message. Supported only for enterprise customers.

  • 3: International/Hong Kong, Macao, and Taiwan message. Supported only for enterprise customers.

  • 7: Digital message.

0
SignName

string

No

The signature name.

Alibaba Cloud Platform
SkuCode

string

No

The specification code of Short Message Service.

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

F655A8D5-B967-440B-8683-DAD6FF8DE990

Code

string

The request status code. Valid values:

  • OK: The request is successful.

  • Other error codes: For more information, see Error codes.

OK
Message

string

The description of the status code.

OK
Data

object

The returned data.

TotalSize

integer

The total number of returned entries.

20
TargetList

array<object>

The list of returned data.

object

TotalCount

integer

The number of successfully sent messages (billable messages).

20
RespondedSuccessCount

integer

The number of messages for which successful receipts are received.

17
RespondedFailCount

integer

The number of messages for which failed receipts are received.

2
NoRespondedCount

integer

The number of messages for which no receipts are received.

1
SendDate

string

The SMS sending date. 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.