Common parameters include common request parameters and common response parameters. To send a Short Message Service (SMS) API request, you must send an HTTP GET request to the SMS endpoint. You must add the request parameters that correspond to the API operation being called. After you call the API, the system returns a response.

Common request parameters

Note The sample code in this topic has been formatted to improve readability.
Table 1. Common request parameters
Parameter Type Required Description
Format String No The format in which to return the response. Valid values:

JSON and XML.

Version String Yes The version number of the API. The format is YYYY-MM-DD. Set the value to

2017-05-25.

AccessKeyId String Yes The AccessKey ID provided to you by Alibaba Cloud.
Timestamp String Yes The timestamp of the request. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

For example, you can set this parameter to 2013-01-10T12:00:00Z, which indicates 20:00:00 on January 10, 2013 (UTC+8).

SignatureNonce String Yes A unique, random number used to prevent replay attacks.

You must use different numbers for different requests.

Sample requests

https://sms.aliyuncs.com/?Format=xml
&Version=2018-05-10
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&Timestamp=2018-05-10T12:00:00Z 

Common response parameters

API responses use the HTTP response format where a 2XX status code indicates a successful call and a 4XX or 5XX status code indicates a failed call. Responses can be returned in either the JSON or XML format. You can specify the response format in the request. The default response format is XML.

Every response returns a unique RequestId regardless of whether the call is successful.
  • XML format
    <? xml version="1.0" encoding="utf-8"? > 
        <!-Result Root Node-->
        <Interface Name+Response>
            <!-Return Request Tag-->
            <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
            <!-Return Result Data-->
        </Interface Name+Response>
    					
  • JSON format
    {
        "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
        /*Return Result Data*/
        }