Dialogue - 对话

更新时间:
复制 MD 格式

对话。

调试

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

授权信息

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

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

请求参数

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

实例 ID

36e9a4cd-a821-4f78-86fa-a9a4aefeea2e
ScriptIdstring

场景 ID

0a88e269-01f5-49ac-97af-5830f0ccb271
SessionIdstring

对话 ID

07d72ea0-6e38-48d4-8371-14deaaba996f
Extrasstring

附属参数。 如静默超时:[{"dataType":"Silence"}]

注意 dataType 类型: DTMF、Silence、RuntimePrompts

说明
  • 当 dataType 为 DTMF 类型时,格式:[{"dataType":"DTMF","dtmf":"xxxx"}]
  • 当 dataType 为 Silence 类型时,格式:[{"dataType":"Silence"}]
  • 当 dataType 为 RuntimePrompts 类型时,格式:[{"dataType":"RuntimePrompts","prompts":"xxxx","persistent":false/true}]
  • [{ "dataType": "Silence" }]
    Utterancestring

    用户说话内容

    行吧,那我就不打扰您了,再见。

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    POP 的请求 ID

    9DB8BA95-4513-54B9-9C67-A28909CFB4AD
    HttpStatusCodeinteger

    HTTP 状态码,200 表示 HTTP 返回成功

    200
    Messagestring

    HTTP 返回消息

    SUCCESS
    Codestring

    业务状态码,OK 表示返回成功

    OK
    Dataobject

    业务数据

    Answerstring

    机器人回复内容

    不好意思,我没听
    StreamEndboolean

    流式返回是否结束

    true
    SessionIdstring

    对话 ID

    07d72ea0-6e38-48d4-8371-14deaaba996f
    StreamIdstring

    对话的轮次 ID

    1
    StartTimelong

    开始时间

    1774858849987
    EndTimelong

    结束时间

    1752283603978
    ControlParamsListarray<object>

    控制参数列表

    ControlParamsobject

    控制参数

    Typestring

    控制参数类型

    说明
  • HangUp: 挂断
  • Transfer:转接
  • GatherDtmf: 获取按键
  • Voice:语音
  • Voice
    Paramsarray

    错误参数。

    paramstring

    动态错误参数

    -

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "9DB8BA95-4513-54B9-9C67-A28909CFB4AD",
      "HttpStatusCode": 200,
      "Message": "SUCCESS",
      "Code": "OK",
      "Data": {
        "Answer": "不好意思,我没听",
        "StreamEnd": true,
        "SessionId": "07d72ea0-6e38-48d4-8371-14deaaba996f",
        "StreamId": 1,
        "StartTime": 1774858849987,
        "EndTime": 1752283603978,
        "ControlParamsList": [
          {
            "Type": "Voice"
          }
        ]
      },
      "Params": [
        "-"
      ]
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2026-04-20新增 OpenAPI查看变更详情