Common parameters-Voice Bot(Outbound Bot)-阿里云帮助中心

This topic describes the request and response parameters that are required for every API call.

Common request parameters

Table 1. Common request parameters
Name	Type	Required	Description
Format	String	No	The format of the response message. Valid values: JSON (default) \| XML
Version	String	Yes	The API version. The value must be in the YYYY-MM-DD format. Example: 2019-12-26
AccessKeyId	String	Yes	The AccessKey ID used to access the service.
Signature	String	Yes	The signature string.
SignatureMethod	String	Yes	The signature method. Valid value: HMAC-SHA1
Timestamp	String	Yes	The timestamp of the request. The value must be in UTC and comply with the ISO 8601 standard. The format is YYYY-MM-DDThh:mm:ssZ. For example, 20:00:00 on January 10, 2013 (UTC+8) is represented as 2013-01-10T12:00:00Z.
SignatureVersion	String	Yes	The version of the signature algorithm. Valid value: 1.0
SignatureNonce	String	Yes	A unique random number used to prevent replay attacks. Use a different random number for each request.
ResourceOwnerAccount	String	No	The logon username of the owner of the resource that you want to access.

Example:

http://outboundbot.cn-shanghai.aliyuncs.com/?Action=CreateIntent
&TimeStamp=2014-05-19T10%3A33%3A56Z
&Format=xml
&AccessKeyId=testid
&SignatureMethod=Hmac-SHA1
&SignatureNonce=NwDAxvLU6tFE0DVb
&Version=2019-12-26
&SignatureVersion=1.0
&Signature=Signature

Common response parameters

API responses are returned in a unified format. You can specify the response format, such as XML or JSON, in your request. By default, responses are returned in XML format. Every API response contains a unique RequestId, regardless of whether the call is successful.

A 2xx HTTP status code indicates that the call was successful.
A 4xx or 5xx HTTP status code indicates that the call failed.

The following examples show common response parameters:

XML format

<?xml version="1.0" encoding="utf-8"?> 
    <!--The root node of the result-->
    <APIName+Response>
        <!--The request ID tag-->
        <RequestId>4C467B38-3910-447D-87BC-AC049166F216</RequestId>
        <!--The response data-->
    </APIName+Response>

JSON format

{
    "RequestId":"4C467B38-3910-447D-87BC-AC049166F216",
    /* The response data */
    }