本章节为您介绍了调用阿里云智能联络中心API使用的公共参数,公共参数包含请求参数和返回参数。
公共请求参数
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Format | String | 否 | 返回值的类型,支持JSON与XML,默认为XML。 |
Version | String | 是 | API版本号,用日期格式:YYYY-MM-DD 表达。,本版本对应为2019-10-15。 |
AccessKeyId | String | 是 | 阿里云颁发给用户的访问服务所用的密钥ID。 |
Signature | String | 是 | 签名结果串。 |
SignatureMethod | String | 是 | 签名方式,目前支持HMAC-SHA1。 |
Timestamp | String | 是 | 请求的时间戳。日期格式按照ISO8601标准表示,使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。
例如:2018-3-29T12:00:00Z为北京时间2018年3月29日的20点0分0秒。 |
SignatureVersion | String | 是 | 签名算法版本,目前版本是1.0。 |
SignatureNonce | String | 是 | 唯一随机数。在不同请求间使用不同的随机数值,防止网络重放攻击。
代码示例参见SignatureNonce。 |
SecurityToken | String | 否 | STS临时授权的Token,默认为空。 |
请求示例:
http://aiccs.aliyuncs.com/
?Format=json
&Version=2019-10-15
&Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9o%3D
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=SendCcoSmartCall
&AccessKeyId=XXXXXXX
&Timestamp=2018-03-29T09%3A22%3A32Z
...
公共返回参数
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", /* 返回结果数据 */ }