通话记录接口.docx

北京天润融通科技有限公司 北京亦庄经济技术开发区地盛北街 1 号 北工大软件园 18 号楼 5 层（北京云基地） ：400-686-9009 网址：http://www.ti-通话记录接口接口文档版本号：版本号：V1.1 编写人：刘韵如编写人：刘韵如 编写时间：编写时间：2014-10-24Revision HistoryNameDateReason For ChangesVersion刘韵如2014-10-24创建文档1.0刘韵如2014-12-04优化文档1.1目录目录1.引言..........................................................................................................................................3 编写目的..................................................................................................................................3 背景..........................................................................................................................................3 定义..........................................................................................................................................3 参考资料..................................................................................................................................3 2.概述..........................................................................................................................................3 3.接口说明..................................................................................................................................4 通话记录接口..........................................................................................................................4 通话记录数据库同步接口 ......................................................................................................8 4.示例........................................................................................................................................11 通话记录接口........................................................................................................................11 通话记录数据库同步接口 ....................................................................................................121.引言引言编写目的编写目的为企业技术和产品设计人员提供获取通话记录的接口说明，以实现与第三方平台的互 操作，进行业务定制。

背景背景本方案适用于天润托管型呼叫中心 CCIC2 平台与第三方的基于 B/S 架构的系统间的行 为、数据及事件的交互与传递本方案承载于 HTTP 协议，严格遵守 HTTP 协议规范本方 案的大部分数据传递采用 JSON 格式，采用 JSON 协议框架定义定义参考资料参考资料RFC2616，HTTP 协议 RFC2617，HTTP 认证 JSON：JavaScript Object Notation，一种轻量级的数据交换格式 IVR：Interactive Voice Response，互动式语音应答，即语音导航2.概述概述当企业需要将通话结果、时间等信息保存到本地时，可以调用云平台的通话记录接口 云平台提供了两种接口用作通话信息的获取：通话记录接口支持多种查询条件，适合用于 获取需限定时间、主被叫号码等信息的少量（单次调用至多 1000 条）通话记录；通话记录 数据库同步接口则主要供企业以简单的方式大量下载保存通话信息，并保持信息的完整性 和连续性（单次调用至多 5000 条） 企业依据自身需要选择所使用的接口本地保存通话结果查询特定通话信息补全挂机推送 的缺失数据企业调用通话 记录接口返回json格式通话 记录……3.接口说明接口说明通话记录接口通话记录接口发起者：合作方 接受者：天润融通 接口类型：HTTP 接口 调用方式：POST 返回格式：JSON 数据 URL 规范：http://InterfaceServerIp:portInterfaceServerIp:port /interfaceAction/cdrIbInterface!listCdrIb.actionInterfaceServerIp:port：天润融通接口服务器 IP/域名及接收端口传入参数列表传入参数列表： 必选参数：参数参数要求要求描述描述备注备注hotline可选企业热线号码需要与 enterpriseId 二选一enterpriseId可选企业 Id需要与 hotline 二选一userName必选用户名登录后台用户名，如 adminpwd必选密码对应 username 的密码，md5(md5(md5(md5(登录密码登录密码)seed))seed)，例如：密码为 123456，seed 为 aaa首先 md5(123456)= e10adc3949ba59abbe56e057f20f883e后接 seed：e10adc3949ba59abbe56e057f20f883eaaa再次加密：md5(e10adc3949ba59abbe56e057f20f883eaaa)= d0782bdf141e366014b4bc0d7dc6ea00即为应传入的 pwdseed必选自定字符串用于加密密码可选参数（查询条件及限制等）：参数要求描述备注uniqueId可选唯一标识如果 uniqueId 值非空，则其余查询条件无效，仅hotline、enterpriseId、userName、pwd、seed、uniqueId参数值有效。

即仅查询唯一标识为 uniqueId 的记录信息answerType可选接听状态为空表示全部，clientAnswer 表人工接听, clientNoAnswer表示人工未接听，systemAnswer 表示系统接听，systemNoAnswer 表示系统未接听mark可选标记为空表示全部，1:留言 2:转移 3:咨询 4:三方 5:接收 6:会议 7:交互 9:已进入 IVR 10:未进入 IVR 11:队列中放弃 12:队列中溢出注：其中 mark 值 2,3,4,7 仅在 answerType=clientAnswer 时有效，mark 值 1,5,6,9,10,11,12 在 answerType=sysemAnswer 时有效title可选查询条件qno 表示队列号(多个之间用英文逗号隔开)，tsno 表示组号(多个用英文逗号隔开)，customer_number 表示客户，cno 表示座席工号(多个之间用英文逗号隔开)，number_trunk表示中继号码(多个之间用英文逗号隔开)，client_number 表示座席value可选查询条件值对应 title 的值province可选来电省份为空表示全部，如“四川“，此参数需要 URLEncodecity可选来电城市为空表示全部，如“成都“，此参数需要 URLEncodestartTime可选开始时间格式“yyyy-mm-ddhh:mm:ss”，例如：2012-08-01 00:00:00，默认当月第一天endTime可选结束时间格式“yyyy-mm-ddhh:mm:ss”，例如：2012-08-08 00:00:00，默认当月最后一天userField可选用户自定义字段外呼接口传入或在语音流程中配置的 userField 字段start可选从第几条开始取正整数，大于等于 0，默认 0limit可选需要取出的数据条数正整数，大于 0，最大不能超过 1000，默认 10返回值：返回值：此接口返回 JSON 格式数据。

数据格式： {“result”:”返回结果”, “msg”:{ “data”:[{通话记录数据},{}..], “paging”:{“从第几条开始取“:“0“,“总条数“:15,“本页条数“:10}} }resultmsgdescriptionsuccess{“result“:“success“,“msg“:{“data“:[{“uniqueId“:“ccic_dev_11-1344493753.3“,“hotline“:“4008001234“,“numberTrunk“:“01087120766“,“customerNumber“:“01087125972“,“customerProvince“:“北京“,“customerCity“:“北京“,“queueName“:“0001“,“cno“:“2002“,“clientNumber“:“01041005968“,“status“:“座席接听“,“startTime“:“2012-08-成功返回通话信息09 14:29:13“,“bridgeTime“:“2012-08-09 14:30:11“,“bridgeDuration“:“00:00:03“,“cost“:“0.000“,“totalDuration“:“00:01:01“,“recordFile“:“20120809/3000001-20120809142913-01087125972-01041005968-record-ccic_dev_11-1344493753.3.mp3“,“inCaseLib“:“不在“,“score“:“0“,“callType“:“普通呼入“,“comment“:“无“,“ivrName“:“转咨询队列“,“endReason“:“座席挂机“,“userField“:“xxx“,“sipCause“:“0“},...],“paging“:{“start“:“0“,“totalSize“:34,“pageSize“:2}}} error“无权访问“查询通话记录失败原因说明： data 取值为 json 数组。

jsonjson 格式数据记录格式数据记录 data 的各属性定义：的各。