Dialogue - 和机器人对话

CC回调外呼的机器人对话接口。(已废弃)。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:Dialogueupdate
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

af81a389-91f0-4157-8d82-720edd02b66a
CallIdstring

呼叫 ID

1528189846043
CallTypestring

呼叫类型,一般 Outbound

Outbound
ScenarioIdstring

场景 ID

6cea9bed-63e6-439e-ae4c-b3333efff53d
TaskIdstring

任务 ID

ff44709e-39a6-43ba-959b-20fcabe3e496
Utterancestring

用户表述

是的
ActionKeystring

外呼需要执行的动作,Hangup 挂机

broadcast
ActionParamsstring

执行动作需要的参数(已废弃)

""
CallingNumberstring

主叫号码

1***6
CalledNumberstring

被叫号码

135****4353
ScriptIdstring

场景 ID

c5c5d8c0-c0f1-48a7-be2b-dc46006d888a

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
Codestring

接口状态码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
Feedbackobject

返回对话信息

Actionstring

给 IVR 的指令

broadcast
ActionParamsstring

指令参数

""
Contentstring

对话文本

你好,我是**客服
Interruptibleboolean

是否可以打断播报

true
ContentParamsstring

已废弃

“”

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Feedback": {
    "Action": "broadcast",
    "ActionParams": "\"\"",
    "Content": "你好,我是**客服",
    "Interruptible": true,
    "ContentParams": "“”"
  }
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
2024-07-22OpenAPI 错误码发生变更查看变更详情