本章节为您介绍了调用阿里云RTC API使用的公共参数，公共参数包含请求参数和返回参数。

公共请求参数

公共请求参数是每个接口都需要使用到的请求参数。

参数 类型 是否必选 描述
Format String 否 返回值的类型，支持JSON与XML，默认为XML。
Version String 是 API版本号，为日期形式：YYYY-MM-DD，本版本对应为2018-01-11。
AccessKeyId String 是 访问服务所用的密钥ID。
Signature String 是 签名结果串。详情请参见：签名机制。
SignatureMethod String 是 签名方式，取值：HMAC-SHA1。
Timestamp String 是 请求的时间戳。日期格式按照ISO8601标准表示，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。

例如：2019-12-29T12:00:00Z为北京时间2019年12月29日的20点0分0秒。
SignatureVersion String 是 签名算法版本，取值：1.0。
SignatureNonce String 是 唯一随机数。在不同请求间使用不同的随机数值，防止网络重放攻击。

代码示例参见SignatureNonce。

SecurityToken String 否 STS临时授权的Token，默认为空。

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

请求示例

http://rtc.aliyuncs.com/
?Format=json 
&Version=2018-01-11
&Signature=L9o%3D**** 
&SignatureMethod=Hmac-SHA1
&SignatureNonce=9166ab59-f445-4005-911d-664c1570df0f
&SignatureVersion=1.0
&Action=ModifyApp
&AccessKeyId=testid  
&Timestamp=2017-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", /* 返回结果数据 */
}