语音呼叫接口 - 接口支持 - 天润融通.doc

自动语音预定/核实接口 接口文档 版 本 号：V1.1 编 写 人：刘韵如 编写时间：2014-10-21  Revision History Name Date Reason For Changes Version 刘韵如 2014-10-21 创建文档 1.0 刘韵如 2014-12-04 更改说明文字 1.1  目录 1. 引言 4 编写目的 4 背景 4 定义 4 参考资料 4 2. 概述 4 通用流程结构 4 3. 对接步骤 6 4. 接口说明 7 语音呼叫接口 7 callback回调接口（sync=0时使用） 10 按键接口 11 5. 常见场景流程 12 预约确认 12 到期提醒 13 6. 附录 15 如何获得呼叫结果 15 如何关联企业业务与通话记录 16 TTS文字内容建议： 16  引言 编写目的 背景 本方案适用于天润托管型呼叫中心CCIC2平台与第三方的基于B/S架构的系统间的行为、数据及事件的交互与传递。本方案承载于HTTP协议，严格遵守HTTP协议规范。本方案的大部分数据传递采用JSON格式，采用JSON协议框架。 定义 参考资料 RFC2616，HTTP协议 RFC2617，HTTP认证 JSON：JavaScript Object Notation，一种轻量级的数据交换格式 IVR：Interactive Voice Response，互动式语音应答，即语音导航 TTS：Text To Speech，文本转语音，即文本朗读 概述 自动语音预定/核实功能基于云平台可定制交互流程的电话外呼接口，通过此接口发起电话呼叫，在被叫方接通后按预设流程播放可定制的语音内容，被叫方可通过电话按键进行反馈，并进入后续流程。 此功能可以使用在任何需要电话呼叫获取回复信息的场景，例如预约信息，下单核实等。 通用流程结构 1）企业的用户通过网页、客户端或APP发起业务请求，如：预订； 2）O2O企业根据收到的请求信息和自身业务逻辑，向语音云平台发送相应呼叫请求； 3）语音云平台拨打商家（即O2O的另一端）的电话，接通后播放语音内容； 4）商家根据播放的语音内容，进行相应按键，按键信息会发送到语音云平台； 5）语音云平台收到按键后，立刻把按键信息返回给O2O企业；也可以选择在电话挂断后返回。 6）O2O企业根据返回的信息，通过App等回复客户。 如下图： 可能使用的接口 语音呼叫接口：发起外呼，进行呼叫； 回调接口（可选）：即时性地获取语音呼叫的被叫客户接听与否等信息； 按键接口（可选）：接受流程中需交互处理的IVR按键，返回下一步信息； 挂机推送接口（可选）：推送按键信息，推送详细呼叫信息（按键、呼叫时间等）； 通话记录接口（可选）：查询详细呼叫结果信息及通话过程中IVR流程信息； 其中，企业通过按键接口和挂机推送接口均可获得用户的按键反馈，若需要在流程中根据不同的按键进入后续流程，需要按键接口，若仅需要通话结束后记录用户按键，则只需要挂机推送接口。 接口1，2，3的说明在本文档下方，接口4，5请参看挂机推送接口文档，通话记录接口文档，具体选择参加附录。 各接口调用位置示意： 对接步骤 整理调用呼叫接口后的语音导航流程图及文案模板； 与云平台技术人员沟通协调，确定呼叫时所需的接口及参数等格式： 企业根据是否有按键后续流程选择使用按键接口或者挂机推送接口获取按键； 企业根据对通话状态和记录的不同获取需求选择回调接口、挂机推送接口或通话记录接口，具体见附录 根据天润融通提供的账号及URL样例进行简单流程测试； 开发发起呼叫的程序； 根据需求分别开发接收呼叫状态回调的Web接口（如果使用异步模式），接收按键的Web接口（流程中立即返回按键），以及接收挂机推送的Web接口（挂机后返回数据） 云平台技术人员配置接口，进行完整流程测试； 录制流程中所需的语音文件并交给云平台技术人员配置； 正式上线 接口说明 语音呼叫接口 发起者：企业 接受者：天润融通云平台 接口类型：HTTP接口 调用方式：POST或GET 返回格式：JSON格式数据 接口说明：该接口需要企业设定流程中所需的自定义变量（通常为语音播放中的变量以及业务编号等）之后，由云平台技术人员配置访问URL。 接口地址： http://Server:Port/interface/entrance/OpenInterfaceEntrance Server:Port：天润融通接口服务器IP/域名及接收端口，域名地址统一为： 接口参数（需要在调用接口的时候传入）： 参数 要求 描述 备注 interfaceType 必选 请求类型 默认值：webCall enterpriseId 必选 企业Id