语音库接口 - 接口文档 - 天润融通.doc

语音短信接口 接口文档 版本号：V1.1 编写人：刘韵如 编写时间：2014-10-16  Revision History Name Date Reason For Changes Version 刘韵如 2014-10-16 创建文档 1.0 刘韵如 2014-12-04 修改参数及说明 1.1  目录 1. 引言 4 编写目的 4 背景 4 定义 4 参考资料 4 2. 概述 4 常见流程 4 3. 对接步骤 5 4. 接口说明 5 呼叫接口 5 callback回调接口（sync=0时使用） 8 语音库接口 9 5. 附录： 11 如何获得呼叫结果 11 如何关联企业业务与通话记录 12 TTS文字内容建议： 12  引言 编写目的 背景 本方案适用于天润托管型呼叫中心CCIC2平台与第三方的基于B/S架构的系统间的行为、数据及事件的交互与传递。本方案承载于HTTP协议，严格遵守HTTP协议规范。本方案的大部分数据传递采用JSON格式，采用JSON协议框架。 定义 参考资料 RFC2616，HTTP协议 RFC2617，HTTP认证 JSON协议 Uniform Resource Identifier (URI): Generic Syntax 概述 语音短信是短信的有效替代产品。通过发起呼叫，播放企业指定语音内容。可实现语音通知，语音告警等功能。 企业可选择传入文本形式的语音内容或自录制的语音文件进行播放。 常见流程 文本内容： 语音内容： 若需要播放更灵活的动态内容或混合使用文本和语音内容，请参见自动语音预订核实接口文档 对接步骤 整理用户接到电话时播放的语音流程图及文案模板； 与云平台技术人员沟通协调，确定呼叫时所需的接口及参数等格式： 如果有大量并发需求，需要用异步调用方式调用呼叫接口，此时若添加回调接口（callback）可以在用户接听或拒接之后及时收到呼叫结果和接通/挂断时间的反馈（通常为30秒内）。 如果可以等到用户通话结束再获取通话结果，并且需要更多详细的通话数据，可以省略callback接口，选择挂机推送接口。 在需要通话结束时间等完整通话数据的情况下需要挂机推送接口。 如果选择播放企业提供的语音文件，需先调用语音库接口上传文件。 根据天润融通提供的账号及URL样例进行简单流程测试； 开发发起呼叫的程序； 根据需求分别开发接收呼叫状态回调的Web接口（如果使用异步模式），以及接收挂机推送的Web接口（挂机后返回数据） 云平台技术人员配置接口，进行完整流程测试； 录制流程中所需的语音文件并交给云平台技术人员配置； 全部测试完毕后后正式上线 接口说明 呼叫接口 接受者：天润融通云平台 接口类型：HTTP接口 调用方式：POST或GET 返回格式：JSON格式数据 接口地址： http://Server:Port/interface/entrance/OpenInterfaceEntrance Server:Port：天润融通接口服务器IP/域名及接收端口，域名地址统一为： 接口参数： 参数 要求 描述 备注 interfaceType 必选 请求类型 默认值：webCall enterpriseId 必选 企业Id 企业编号 userName 必选 用户名 管理员用户名，如：admin pwd 必选 密码 对应username的密码，md5(md5(登录密码)seed)，例如： 密码为123456，seed为aaa 首先md5(123456)= e10adc3949ba59abbe56e057f20f883e 后接seed：e10adc3949ba59abbe56e057f20f883eaaa 再次加密： md5(e10adc3949ba59abbe56e057f20f883eaaa)= d0782bdf141e366014b4bc0d7dc6ea00 即为应传入的pwd seed 必选 自定字符串 用于加密密码 ivrId 必选 回呼接通后进入的ivrid 语音流程编号 需要根据录音单独配置 sync 必选 调用方式 1：同步调用 发起呼叫时，不会立刻返回，当电话接通时，才返回“呼叫成功”；如果电话未接通，超时后才返回“呼叫失败”。 0：异步调用 发起请求后，立刻返回请求结果，如“提交成功”或“提交失败”。当电话接通或未接通后，通过callbackUrl回调呼叫结果。callbackUrl参数参考下面。 customerNumber 必选 电话号码 外呼的号码，座机带区号（如01087120766），区号和号码间无中横线；手机不加0 userField 可选 自定义字段 标识此次呼叫，供后续查询通话记录等使