1、IVR数据采集

该接口是优音云客服提供给第三方编写接口的接口规范.

1、服务地址

由第三方提供一个可以公网访问的地址，支持http/https, 接口地址不限定。提供好后，在IVR里配置。
测试环境：https://domain.thirdpart.com/

2、接口

2.1 web端配置时校验请求

• 说明：主要用于前端配置页面做请求校验接口返回值是否合法
• 地址： /rec
• 方法： POST

请求头

请求体

请求体示例

POST /thirdpart/data/rec01 HTTP/1.1 
User-Agent: PostmanRuntime/7.29.2 
Accept: */* 
Postman-Token: 447d7b9b-cde4-4b35-9857-87216bba313a 
Host: localhost:28980 
Accept-Encoding: gzip, deflate, br 
Connection: keep-alive 
Content-Type: application/json
Content-Length: 9
tenantid=

返回值示例（成功）

 {  
      "data": {  
          "tips1": "主叫号码",                    // 此项的值可以自定义 (字符串类型)
          "tips2": "被叫号码",                    // 此项的值可以自定义 (字符串类型)
          "tips3": "账户额度",                    // 此项的值可以自定义 (字符串类型)
          "tips4": "本月消费",                    // 此项的值可以自定义 (字符串类型)   
          "tips5": "是否已回电",                  // 此项的值可以自定义 (字符串类型)
          "tips6": "快递单是否已打印",            // 此项的值可以自定义 (字符串类型)   
          "agents": ["8000","8001","8002"],     // 此项的值可以是1-3个元素 (数值类型)  
          "sound1": 18811112222,                // 此项的值可以自定义 (数值类型)  
          "sound2": 18123456789,                // 此项的值可以自定义 (数值类型)  
          "sound3": 15666,                      // 此项的值可以自定义 (数值类型)  
          "sound4": 235.55,                     // 此项的值可以自定义 (数值类型)  
          "condition5": "true",                 // 此项的值可以自定义 (字符串类型)  
          "condition6": "false"                 // 此项的值可以自定义 (字符串类型)  
      },    
      "rtnmsg": "success",                  //不可自定义，只能返回success
      "rtncode": 200                        //不可自定义，只能返回200
}

2.2正式通信平台请求接口

• 说明：通信平台发起的请求
• 地址： /rec
• 方法： POST
  请求头

请求体

请求体示例

  POST /thirdpart/data/rec01 HTTP/1.1 
  Content-Type: application/json 
  User-Agent: PostmanRuntime/7.29.2 
  Accept: */* 
  Postman-Token: b4e83c2f-25e5-45fa-8493-c9e5ce9bd30b 
  Host: localhost:28980 
  Accept-Encoding: gzip, deflate, br 
  Connection: keep-alive Content-Length: 189
  {"tenantid":"租户id 设置-开发者中心-开发者凭证-租户ID","sessionid":"呼叫会话唯一 id","ani":"来电主叫号码","dnis":"来电被叫号码","dtmf":"主叫用户按键"}

返回值示例（成功）

 {  
      "data": {  
          "tips1": "主叫号码",                    // 此项的值可以自定义 (字符串类型)
          "tips2": "被叫号码",                    // 此项的值可以自定义 (字符串类型)
          "tips3": "账户额度",                    // 此项的值可以自定义 (字符串类型)
          "tips4": "本月消费",                    // 此项的值可以自定义 (字符串类型)   
          "tips5": "是否已回电",                  // 此项的值可以自定义 (字符串类型)
          "tips6": "快递单是否已打印",            // 此项的值可以自定义 (字符串类型)   
          "agents": ["8000","8001","8002"],     // 此项的值可以是1-3个元素 (数值类型)  
          "sound1": 18811112222,                // 此项的值可以自定义 (数值类型)  
          "sound2": 18123456789,                // 此项的值可以自定义 (数值类型)  
          "sound3": 15666,                      // 此项的值可以自定义 (数值类型)  
          "sound4": 235.55,                     // 此项的值可以自定义 (数值类型)  
          "condition5": "true",                 // 此项的值可以自定义 (字符串类型)  
          "condition6": "false"                 // 此项的值可以自定义 (字符串类型)  
      },    
      "rtnmsg": "success",                  //不可自定义，只能返回success
      "rtncode": 200                        //不可自定义，只能返回200
}

附录

接口说明

• 例如实现主叫查询余额,那么可以在接口返回参数时定义 “tips1”: “本月消费” “sound1”: 余额数, （注：tips1-sound1要前后对应），IVR流程对接口配置校验通过后，在后续路由节点可以获取到变量，变量名称：本月消费 来实现播放 消费数据235.55
• 例如要实现不同case播放对应语音，那么可以在接口返回参数时定义 “tips5”: “是否已回电” “condition5”: “true”, （注：tips5-condition5要前后对应），在后续节点可以获取到变量，变量名称：是否已回电 变量值：true 用于条件路由节点进行转接或挂机等操作
• 例如要根据对应业务控制动态一组坐席来接听通话，那么可以在 “agents”：[“8000”,”8001”,”8002”]，返回指定座席ID。