Query message delivery status with QueryMessage - Short Message Service - Alibaba Cloud - Short Message Service

Queries the SMS delivery records by using the message ID.

Operation description

QPS limits

The queries per second (QPS) limit on this API operation for a single user (within the same Alibaba Cloud account) is 300 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this API operation at a reasonable frequency.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MessageId	string	Yes	The message ID.	1008030xxx3003

Response elements

Element	Type	Description	Example
	object	The response parameters.
Status	string	The delivery status of the SMS message. Valid values: 1: Delivered. 2: Delivery failed. 3: Delivering.	1
ErrorDescription	string	The description of the SMS delivery status code.	success
ResponseCode	string	The submission status of the SMS message.	OK
ReceiveDate	string	The time when the carrier receipt is received for the sent SMS message.	Mon, 24 Dec 2018 16:58:22 +0800
NumberDetail	object	The number details.
Carrier	string	The carrier network to which the number belongs.	CMI
Region	string	The region to which the number belongs.	HongKong
Country	string	The country to which the number belongs.	China
Message	string	The content of the SMS message.	Hello!
ResponseDescription	string	The detailed description of the SMS submission status.	The SMS Send Request was accepted
ErrorCode	string	The delivery status code of the SMS message.	DELIVERED
SendDate	string	The time when the SMS message is forwarded to the carrier.	Mon, 24 Dec 2018 16:58:22 +0800
To	string	The recipient number.	6581xxx810
MessageId	string	The message ID.	1008030xxx3003
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8D28D0

Examples

Success response

JSON format

{
  "Status": "1",
  "ErrorDescription": "success",
  "ResponseCode": "OK",
  "ReceiveDate": "Mon, 24 Dec 2018 16:58:22 +0800",
  "NumberDetail": {
    "Carrier": "CMI",
    "Region": "HongKong",
    "Country": "China"
  },
  "Message": "Hello!",
  "ResponseDescription": "The SMS Send Request was accepted",
  "ErrorCode": "DELIVERED",
  "SendDate": "Mon, 24 Dec 2018 16:58:22 +0800",
  "To": "6581xxx810",
  "MessageId": "1008030xxx3003",
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8D28D0"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.