公共参数包含公共请求参数和公共返回参数。短信服务API接口的调用是通过向API接口的服务端地址发送HTTP GET请求,并按照接口说明在请求中加入相应请求参数完成的。根据请求的处理情况,系统会返回处理结果。
公共请求参数
说明 为便于您的查看,本文档中的示例都做了格式化处理。
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
Format | String | 否 | 返回消息的格式。取值:
JSON或XML。 |
Version | String | 是 | API版本号,使用YYYY-MM-DD日期格式。取值:
2018-05-01。 |
AccessKeyId | String | 是 | 访问服务使用的密钥ID。 |
Timestamp | String | 是 | 请求的时间戳,为日期格式。使用UTC时间按照 ISO8601标准,格式为yyyy-MM-ddTHH:mm:ssZ。
例如,北京时间2013年1月10日20点0分0秒,表示为2013-01-10T12:00:00Z。 |
SignatureNonce | String | 是 | 唯一随机数,用于防止网络重放攻击。
在不同请求间要使用不同的随机数值。 |
Signature | String | 是 | 签名结果串。关于签名的计算方法,请参见签名机制。 |
SignatureMethod | String | 是 | 签名方式,目前仅支持HMAC-SHA1。 |
SignatureVersion | String | 是 | 签名算法版本,目前的版本是1.0。 |
请求示例:
https://dysmsapi.ap-southeast-1.aliyuncs.com/?Format=xml
&Version=2018-05-01
&Signature=Pc5WB8gokVn0xfeu%2FZV%2BiNM1dgI%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=15215528852396
&SignatureVersion=1.0
&AccessKeyId=key-test
&OwnerId=12345678
&Timestamp=2014-10-10T12:00:00Z
公共返回参数
调用API服务后,系统返回的数据采用统一格式,返回2xx的HTTP状态码,表示调用成功;返回4xx或5xx的HTTP状态码,表示调用失败。调用成功返回的数据格式主要有XML和JSON两种,外部系统可以在请求时传入参数来制定返回的数据格式,默认为XML格式。为了便于查看,本文档中的返回示例做了格式化处理,实际返回结果是没有进行换行、缩进等处理的。
每次接口调用,无论成功与否,系统都会返回一个唯一识别码RequestId。- XML格式
<?xml version="1.0" encoding="utf-8"?> <!—结果的根结点--> <接口名称+Response> <!—返回请求标签--> <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId> <!—返回结果数据--> </接口名称+Response>
- JSON格式
{ "RequestId":"4C467B38-3910-447D-87BC-AC049166F216", /*返回结果数据*/ }