Dialogue - 和机器人对话

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:Dialogue

update

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID

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

CallId

string

是

呼叫 ID

1528189846043

CallType

string

是

呼叫类型,一般 Outbound

Outbound

ScenarioId

string

否

场景 ID

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

TaskId

string

否

任务 ID

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

Utterance

string

是

用户表述

是的

ActionKey

string

否

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

broadcast

ActionParams

string

否

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

""

CallingNumber

string

是

主叫号码

1***6

CalledNumber

string

是

被叫号码

135****4353

ScriptId

string

否

场景 ID

c5c5d8c0-c0f1-48a7-be2b-dc46006d888a

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200

Code

string

接口状态码

OK

Message

string

接口提示消息

Success

RequestId

string

请求 ID

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

Success

boolean

是否成功

true

Feedback

object

返回对话信息

Action

string

给 IVR 的指令

broadcast

ActionParams

string

指令参数

""

Content

string

对话文本

你好,我是**客服

Interruptible

boolean

是否可以打断播报

true

ContentParams

string

已废弃

“”

示例

正常返回示例

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

错误码

错误信息

描述

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. 指定的实例不存在。

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

变更历史

更多信息,参考变更详情。