服务端
服务端API文档

用户应答回调节点

更新时间: 2022/01/17 13:04:57

用户应答回调节点

  • IVR与用户业务系统进行交互使用
  • 回调节点将收集到的客户信息回调用户系统,用户系统应答,携带相关变量参数
  • 支持动态流转到其他节点,节点需要为当前的子节点,携带用户传过来的变量
  • 支持动态流转到其他ivr流程,携带用户传过来的变量,流转树和流转节点同时配置,优先流转到ivr树
  • 不指定具体流转节点,同时如果只有一个子节点,直接流转到对应节点即可,携带用户传过来的变量,如果下一个节点时判断节点,通过回传的judgeValue参数进行判断
  • 如果没有指定,且回调节点下面还有多个节点,报错,需指定流转节点

URL

  • 请求方法:POST
  • URL:http://voip-host/api/v1/voip/cti/app/ivr/callback

请求参数

参数名称 类型 是否必选 示例 描述
appId string 必填 eca23f68c66d4acfceee77c200200359 应用ID。
callId uuid 必填 776c3a0f2a7b3f3c6cff9ba0a6ecd445 会话id,ivr回调节点回调用户系统的时候会带过来,详看回调节点。
ivrTreeId long 选填 5609 跳转的ivr树id,用户可指定跳转到对应的ivr树上,如果ivrTreeId和ivrNodeId同时配置,已ivrTreeId为准。
ivrNodeId long 选填 5034 跳转的ivr节点的id,该节点必须在回调节点下存在,用户可指定跳转到对应的ivr子节点上,如果ivrTreeId和ivrNodeId同时配置,已ivrTreeId为准。
judgeValue int 选填 10 条件判断值,目前条件判断只支持int类型,判断条件是在判断节点进行配置的:<,>,=, !=,<=,>=。
variableMap map 选填 {"money": "112"} 用户传过来的变量名,用户携带过来的变量的值,key - value,用于替换nodeword中的变量,支持单个和多个变量赋值。
  • 节点属性nodeAttr具体值请查看“IVR节点配置案例”

返回参数

参数名称 类型 示例 描述
code int 0 状态码。
message string OK 请求成功或者失败描述信息。

示例

请求示例

  • 跳转到大于10的对应节点上
{
    "appId": "776c3a0f2a7b3f3c6cff9ba0a6ecd445",
    "callId": "67822d62-1a9a-40c8-aab1-ace62452963f",
    "judgeValue": 10,
    "variableMap": {
        "money": "112"
    }
}

正常返回示例

{
  "code": 0,
  "message": "OK",
}
此文档是否对你有帮助?
有帮助
去反馈
  • 用户应答回调节点
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 正常返回示例