公共参数是每个接口都需要使用到的请求参数。本文为您介绍了调用阿里云语音通信API使用的公共参数,公共参数包含请求参数和返回参数。

公共请求参数

参数 类型 是否必选 描述
Format String 返回值的类型。支持JSON与XML,默认为XML。
Version String API版本号。为日期形式:YYYY-MM-DD,本版本对应为2017-05-25。
AccessKeyId String 阿里云颁发给用户的访问服务所用的密钥ID。AccessKey用于调用API。
Signature String 请求签名,即最终生成的签名结果值。如何生成请求签名,请参见请求签名
SignatureMethod String 签名方式。目前支持HMAC-SHA1。
Timestamp String 请求的时间戳。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。
SignatureVersion String 签名算法版本,目前版本是1.0。
SignatureNonce String 签名唯一随机数。用于防止网络重放攻击,建议您每一次请求都使用不同的随机数。
SecurityToken String STS临时授权的Token,默认为空。

相关概念详情请参见账号权限STS临时授权访问

请求示例:

http://dyvmsapi.aliyuncs.com/?Format=json 
&Version=2017-05-25
&Signature=vpEEL0zFHfxXYzSFV0n7%2FZiFL9****
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570****
&SignatureVersion=1.0
&Action=ModifyApp
&AccessKeyId=XXXXXXX 
&Timestamp=2018-3-29T12: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", 
    /*返回结果数据*/
    }