DPL

# Message Interaciton Command

信息交互类指令 Command 类型

# SendEvent

当组件绑定 SendEvent 类型的 Command 时,点击会触发组件上报 UserEvent 事件, 用户可以自定义参数

# 消息样例

{
    "type": "SendEvent",
    "componentId": "{{STRING}}"
    "delay": {{INTEGER}},
    "dWhen": "{{STRING}}",
    "dialogType": "{{STRING}}",
    "arguments": [
        "{{STRING}}",
        ...
    ]
}
  • type
    • 固定 SendEvent
  • componentId
    • 绑定的组件id
  • (optional) delay
    • 指令在端上的延迟执行时间，单位毫秒，默认为 0
  • (optional) dWhen
  • (optional) dialogType
    • 标识用户基于该事件请求上报时，携带当前会话状态的类型，枚举，取值如下
      • CURRENT（默认），多用于上报多个事件时，都能够得到响应并被执行的场景；本次事件上报基于当前对话轮次，设备端在进入下一轮对话后，会将收到的基于上一轮对话的云端返回指令丢弃掉
      • NEW ，多用于场景的切换、新页面的请求，标识本次事件上报操作将开启新的一轮对话，设备端在执行该事件后会更新自身的轮次状态（基于之前轮次对话事件的响应指令都将被丢弃）
  • arguments
    • 动态的自定义参数

# OpenBot

支持用户通过点击等方式基于botId跳转到指定bot

# 消息样例

{
    "type": "OpenBot",
    "botId": {{STRING}},
    "targetPath": {{STRING}},
    "delay": {{INTEGER}},
    "dialogType": "{{STRING}}",
    "dWhen": "{{STRING}}",
    "params": {
        "{{STRING}}": "{{STRING}}",
        ...
    }
}

# 参数说明

  • type
    • 固定 OpenBot
  • botId
    • 跳转目标bot的botId
  • (optional) params
    • 跳转目标bot需要携带的参数
  • (optional) targetPath
    • 跳转目标bot的时对应的path
  • (optional) delay
    • 指令在端上的延迟执行时间，单位毫秒，默认为 0
  • (optional) dWhen
  • (optional) dialogType
    • 标识用户基于该事件请求上报时，携带当前会话状态的类型，枚举，取值如下
      • CURRENT 本次事件上报基于当前对话轮次，设备端在进入下一轮对话后，会将收到的基于上一轮对话的云端返回指令丢弃掉（默认）
      • NONE 本次事件上报不基于具体的某一次对话，设备端收到对应云端返回指令后会立即执行（与其他指令独立并行执行）
      • NEW 标识本次事件上报操作将开启新的一轮对话，设备端在执行该事件后会更新自身的对话轮次状态（基于之前轮次对话事件的响应指令都将被丢弃)

← 特殊类指令 →