CC回调外呼的机器人对话接口。(已废弃)
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | Dialogue | 系统规定参数。取值:Dialogue。 |
CalledNumber | String | 是 | 135****4353 | 被叫号码 |
CallId | String | 是 | 1528189846043 | 呼叫id |
CallingNumber | String | 是 | 1***6 | 主叫号码 |
CallType | String | 是 | Outbound | 呼叫类型,一般Outbound |
InstanceId | String | 是 | af81a389-91f0-4157-8d82-720edd02b66a | 实例id |
Utterance | String | 是 | 是的 | 用户表述 |
ScenarioId | String | 否 | 6cea9bed-63e6-439e-ae4c-b3333efff53d | 场景id |
TaskId | String | 否 | ff44709e-39a6-43ba-959b-20fcabe3e496 | 任务id |
ActionKey | String | 否 | broadcast | 外呼需要执行的动作,Hangup 挂机 |
ActionParams | String | 否 | "" | 执行动作需要的参数(已废弃) |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK | 接口状态码 |
Feedback | Struct | 返回对话信息 |
|
Action | String | broadcast | 给ivr 的指令 |
ActionParams | String | “” | 指令参数 |
Content | String | 你好,我是**客服 | 对话文本 |
Interruptible | Boolean | true | 是否可以打断播报 |
HttpStatusCode | Integer | 200 | http 状态码 |
Message | String | Success | 接口提示消息 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求id |
Success | Boolean | true | 是否成功 |
示例
请求示例
http(s)://[Endpoint]/?Action=Dialogue
&CalledNumber=135****4353
&CallId=1528189846043
&CallingNumber=1***6
&CallType=Outbound
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&Utterance=是的
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Feedback>
<Action>broadcast</Action>
<ActionParams/>
<Content>你好,是我**客服</Content>
<Interruptible>true</Interruptible>
</Feedback>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>
JSON
格式
{
"RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Feedback":{
"Action":"broadcast",
"ActionParams":"",
"Content":"你好,是我**客服",
"Interruptible":true
},
"HttpStatusCode":200,
"Code":"OK",
"Success":true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
访问错误中心查看更多错误码。