Pulls message delivery reports from a message queue. Alibaba Cloud Short Message Service (SMS) pushes message delivery reports to a specified message queue. To view the queue name, log on to the SMS console.

Request parameters

Note You can specify a Message Service (MNS) queue or an HTTP URL to receive SMS delivery status reports that are pushed by SMS. Then, call the SmsReport operation to pull the message delivery reports from the MNS queue or HTTP server. You must specify the following parameters when you call this operation.

For more information about how to specify a queue or an HTTP URL, see Consumption modes of message delivery reports.

If SMS messages are sent from regions outside mainland China to mainland China, specify the following parameters when you call this operation.
Parameter Type Description Example
PhoneNumber String Receiver Phone Number 159****5678
SendStatus String Transmission Status The status that indicates whether the text message was sent.
  • 1: The text message was sent.
  • 2: The text message failed to be sent.
  • 6: The text message expired.
BizId String The ID of the delivery receipt. 1234567^0
ExternalId String The ID of the batch. Set this parameter to the value of the outId parameter that is specified when you call an API operation to send text messages. 123456
SendDate String The time when the text message was sent. 2020-05-01 10:00:00
ReceiveDate String The time when the SMS delivery receipt was received from the carrier. 2020-05-01 10:00:03
ErrorCode String The error code. UNKNOW
ErrorMessage String The error message. An unknown error occurred.
SmsQuantity String Each text message must be 1 to 140 bytes in length. If a text message exceeds 140 bytes, it is separated into multiple text messages. 1, 2, 3
If SMS messages are sent from mainland China to regions outside mainland China, specify the following parameters when you call this operation.
Parameter Type Description Example
To String Receiver Phone Number 159****5678
Status String Transmission Status The status that indicates whether the text message was sent.
  • 1: The text message was sent.
  • 2: The text message failed to be sent.
  • 6: The text message expired.
MessageId String The ID of the delivery receipt. 123456789
TaskId String The ID of the batch. Set this parameter to the value of the taskId parameter that is specified when you call an operation to send messages. 123456
SendDate String The time when the text message was sent. 2020-05-01 10:00:00
ReceiveDate String The time when the SMS delivery receipt was received from the carrier. 2020-05-01 10:00:03
ErrorCode String The error code. UNKNOW
ErrorDescription String The error message. An unknown error occurred.

Examples

Sample requests
[
  {
    "PhoneNumber" : "1390****001",
    "SendDate" : "2017-01-01 00:00:00",
    "ReceiveDate" : "2017-01-01 00:00:00",
    "SendStatus" : "1",
    "ErrorCode" : "UNKNOW",
    "ErrorMessage": "An unknown error occurred.",
    "SmsQuantity" : "1,2,3",
    "BizId" : "1234567^0",
    "ExternalId" : "67890"
  }
]
Sample success response

{
  "code" : 0,
  "msg": "RECEIVED."
}