-接口文档-天润融通.docVIP

外呼 接口文档 版本：1.0 北京天润融通科技有限公司 2012年 07月11日 Revision History Name Date Reason For Changes Version 安静波 12/07/11 初始 1.0 冯炜 14/02/14 增加客户侧号码参数 1.1 冯炜 引言 编写目的 为开发人员提供一个规范化的接口协议，以实现与第三方平台的互操作，进行业务定制。 背景 本协议适用于天润托管型呼叫中心Clink平台与第三方的基于B/S架构的系统间的行为、数据及事件的交互与传递。本协议承载于HTTP协议，严格遵守HTTP协议规范。本协议的大部分数据传递采用JSON格式，采用JSON协议框架。 通过本接口，第三方平台可以给天润托管型呼叫中心发送呼叫请求，天润系统分别呼叫客户和座席，并把双方接通。 定义 参考资料 RFC2616，HTTP协议 RFC2617，HTTP认证 XML协议 Uniform Resource Identifier (URI): Generic Syntax 概述 在整个业务系统中，可以简单分为天润托管呼叫中心平台和企业业务系统两个部分，而本文档所定义的接口就是处在这两个部分之间，实现两个系统之间的互操作和数据交换，如图表 1所示。 图表 1 呼叫中心后台与企业业务系统直接接口模式 图表 2 通过WEB浏览器的接口模式 呼叫中心协议采用HTTP协议承载，HTTP协议采用请求/回应式的、非对称的数据传递方式，而我们所需要的接口应该是双向的、实时性强的数据通道。在图表 1模式下，企业需要一个HTTP客户端，向呼叫中心发起操作请求，也需要企业侧部署一个WEB服务器，以接收来自呼叫中心事件通知，或持续的数据传递； 对于外呼接口调用策略建议 1：有工具条对接的情况下 外呼的操作要结合座席当前状态 调用外呼前，调用工具条的方法来判断座席的状态，如果座席状态不是整理和空闲，不能允许再次发起点击，在页面前端即控制调用，给予提示（我们自己的座席端的处理方式） ? 2：不做工具条，仅做CRM外呼接口调用 此时因无法拿到座席状态， 使用座席上下线接口，在CRM登录时统一调用，CRM登录调用上线接口，下线调用退出接口 /index.php?m=contentc=indexa=listscatid=70 调用方式（适用工具条对接外呼） 方案1：异步调用外呼接口的情况下，点击外呼操作做延迟处理 ? 调用外呼接口后要延迟5s以上，并在页面给予提示“呼叫中，请稍后”res返回值会在提交后就返回，这种延迟处理可避免一些快速的点击呼叫造成接口风险（已在其他客户使用中发现） 方案2：使用同步模式 ? 外呼接口设置sync=1，res返回值会在座席响铃后返回，大概会延迟3-4s，在未返回结果信息前可以给予提示，“呼叫中，请稍后”这样可以更精准的判断呼叫进程，避免堆积，但可能会占用调用程序的线程和资源，请评估 方案3：判断外呼结束标识 ? 设置外呼响铃接口，调用外呼接口后，在未收到挂机推送呼叫结束（自行判断本座席cno或这用sync=1的UniqueID做匹配），再允许呼叫下一次（风险，推送失败会导致无法再呼叫，还是要配合超时机制做容错，但是这种方案会相对准确） /interface/PreviewOutcall?enterpriseId=cno=pwd=customerNumber=userField= 相关参数 参数 要求 描述 备注 enterpriseId 必选 企业ID enterpriseId必选，企业后台右上角的企业编号 cno 必选 座席号 比如2000此座席必须在线 pwd 必选 密码 登录密码MD5加密 customerNumber 必选 客户电话号码 客户方电话号码。 userField 可选 用户自定义参数 数据会写入cdr中，供第三方调用解析 clidLeftNumber 可选 客户侧外显号码 可传入企业中继号码或设置好的客户侧外显号码 sync 可选 是否异步调用 1：同步调用 0：异步调用 默认为异步调用（提交请求成功后返回结果） 返回值 此接口为同步接口,当通过验证开始呼叫座席后只有座席接听/呼叫超时/呼叫失败时才会返回。 JSON格式数据 {res:0,uniqueId2343} 注：uniqueId仅在同步调用(sync=1)时返回。 res返回值 描述 0 sync=1时表示座席已接听，sync=0时表示发起呼叫请求成功 1 呼叫座席失败 2 参数不正确 3 用户验证没有通过 4 账号被停用 资费不足 6 指定的业务尚未开通 7 电话号码不正确 8 座席工