All Products
Search
Document Center

SMS Status Query API

Last Updated: Jan 09, 2019

Input Parameters

Name Type O/M Sample Value Description
PhoneNumber String Mandatory 452220121 “1. Only one phone number is allowed at one time when calling an API.2. The format of Phone Number: Country Code+Phone Number
BizId String Optional 1234^1234 The ID generated by Alibaba Clould, to uniquely identify the serial number of SMS sending request.
StartDate String Mandatory 2018-06-06T00:00:00+0800 The start time of the query window. Please use UTC+8 Time Zone.
EndDate String Mandatory 2018-06-06T23:59:59+0800 The end time of the query window. Please use UTC+8 Time Zone.
PageSize Number Optional 10 To control the size of query results, an Application Developer can split the results into many pages and each time with one page returned. Maximum support 50 pages.
CurrentPage Number Optional 1 Current page.

Output Parameters

Name Type Sample Value Description
RequestId String 8906582E-6722 The Serial Number generated for SMS Status Query API calling.
ResultCode String OK The code indicates if the SMS Query request is accepted by the Alibaba Platform or not accepted. “OK”indicates accepted. Other codes are for different errors. For details please refer to Result Code list.
ResultMessage String Successful The description of different message results.
TotalCount Number 100 Total quantity of messages. For an SMS created by an application with a character length of more than 140 characters, the system will split it into several message.
SmsSendDetails Object - The status details of each message.

SmsSendDetails Object

Name Type Sample Value Description
PhoneNumber String 452220121 Phone number to receive the message.
SendStatus Number 1 “Status of the message: 1:Submitted 2: Failed 3: Delivered
ErrorCode String DELIVERED Result code returned from the telecome network.
ContentCode String SMS_000 The ID of the message content.
Content String Hello! The content of the message.
SendDate String 5/25/2017 0:00:00 The time the message was sent.
ReceiveDate String 5/25/2017 0:00:00 The time the message was delivered.
ExternalId String 123 The ID generated by the Application Developer to uniquely identify the serial number of the SMS sending request.