Queries text messages.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | QueryMessage |
The operation that you want to perform. Valid values: QueryMessage cluster. |
MessageId | String | Yes | 1008030xxx3003 |
The ID of the text message. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ErrorCode | String | DELIVERED |
The status code that indicates whether the text message was delivered. |
ErrorDescription | String | success |
The description of the status code that indicates whether the text message was delivered. |
Message | String | Hello! |
The content of the text message. |
MessageId | String | 1008030xxx3003 |
SMS sending ID |
NumberDetail | Struct |
The details of the mobile phone number. |
|
Carrier | String | CMI |
The carrier that provides the mobile phone number. |
Country | String | Hongkong, China |
The country to which the mobile phone number belongs. |
Region | String | HongKong |
The region to which the mobile phone number belongs. |
ReceiveDate | String | Mon, 24 Dec 2018 16:58:22 +0800 |
The time when the delivery receipt was received from the carrier. |
ResponseCode | String | OK |
The status code that indicates whether the request of sending the text message was submitted. |
ResponseDescription | String | The SMS Send Request was accepted |
The detailed description of the status code that indicates whether the request of sending the text message was submitted. |
SendDate | String | Mon, 24 Dec 2018 16:58:22 +0800 |
The time when the text message was sent to the carrier. |
Status | String | 1 |
The status that indicates whether the text message was sent.
|
To | String | 6581xxx810 |
The mobile phone number that received the text message. |
Examples
Sample requests
http(s)://dysmsapi.ap-southeast-1.aliyuncs.com/?Action=QueryMessage&MessageId=1008030xxx3003&<common request parameters>
Sample success responses
XML
format
<QueryMessageResponse> <ErrorCode>DELIVERED</ErrorCode> <ErrorDescription>success</ErrorDescription> <Message>Hello! </Message> <NumberDetail> <Carrier>CMI</Carrier> <Country>Hongkong, China</Country> <Region>HongKong</Region> </NumberDetail> <ReceiveDate>Mon, 24 Dec 2018 16:58:22 +0800</ReceiveDate> <ResponseCode>OK</ResponseCode> <ResponseDescription>The SMS Send Request was accepted</ResponseDescription> <SendDate>Mon, 24 Dec 2018 16:58:22 +0800</SendDate> <Status>1</Status> <To>6581xxx810</To> </QueryMessageResponse>
JSON
Format
{ "ErrorCode": "DELIVERED", "ErrorDescription": "success", "Message": "Hello!", "NumberDetail": { "Carrier": "CMI", "Country": "Hongkong, China", "Region": "HongKong" }, "ReceiveDate": "Mon, 24 Dec 2018 16:58:22 +0800", "ResponseCode": "OK", "ResponseDescription": "The SMS Send Request was accepted", "SendDate": "Mon, 24 Dec 2018 16:58:22 +0800", "Status": 1, "To": "6581xxx810" }
Error code
Go to the Error CenterFor more information, see error codes.