调用RobotCall发起机器人外呼。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RobotCall

系统规定参数。取值:RobotCall

CalledShowNumber String 0571****5678

外呼主叫号码。

CalledNumber String 131****2204

被叫号码。

RobotId Long 350000****

机器人ID(话术ID)。

OutId String abcdefgh

预留给调用方使用的ID。

最终会通过在回执消息中将此ID带回给调用方。字符串类型,长度为1~15个字节。

RecordFlag Boolean true

通话过程是否录音。取值:

  • true
  • false
EarlyMediaAsr Boolean false

是否启用号码状态(早媒体)识别标识。取值:

  • false(默认值)
  • true
Params String {"name":"张三","age","25"}

机器人的参数列表。JSON格式。总长度不要超过512个字节。

返回数据

名称 类型 示例值 描述
Message String OK

状态码的描述。

RequestId String A90E4451-FED7-49D2-87C8-00700A8C4D0D

请求ID。

Data String 116012854210^10281427*****

此次通话的唯一回执ID。

Code String OK

请求状态码。返回OK代表请求成功。

示例

请求示例

http(s)://aiccs.aliyuncs.com/?AccessKeyId=123456
&Action=RobotCall
&CalledShowNumber=0571****5678
&CalledNumber=131****2204
&OutId=abcdefgh
&RecordFlag=true
&EarlyMediaAsr=false
&Params={"name":"张三","age","25"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<RobotCallResponse>
    <Message>OK</Message>
    <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>
    <Data>116012854210^10281427*****</Data>
    <Code>OK</Code>
</RobotCallResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "OK",
  "RequestId" : "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
  "Data" : "116012854210^10281427*****",
  "Code" : "OK"
}

错误码

HttpCode 错误码 错误信息 描述
400 Permission.NotAuthorized Insufficient permissions. Please contact the primary account administrator. 权限不足,请联系主账号管理员
400 Parameter.Error Parameter error. 参数错误

访问错误中心查看更多错误码。