通话记录接口.docx

通话记录接口接口文档版本号：V1.1编写人：刘韵如编写时间：2014-10-24Revision HistoryNameDateReason For ChangesVersion刘韵如2014-10-24创建文档1.0刘韵如2014-12-04优化文档1.1目录1.引言3编写目的3背景3定义3参考资料32.概述33.接口说明4通话记录接口4通话记录数据库同步接口84.示例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条）。企业依据自身需要选择所使用的接口。3. 接口说明通话记录接口发起者：合作方接受者：天润融通接口类型：HTTP接口调用方式：POST返回格式：JSON数据URL规范：http:/InterfaceServerIp:port /interfaceAction/cdrIbInterface!listCdrIb.actionInterfaceServerIp:port：天润融通接口服务器IP/域名及接收端口传入参数列表：必选参数：参数要求描述备注hotline可选企业热线号码需要与enterpriseId二选一enterpriseId可选企业Id需要与hotline二选一userName必选用户名登录后台用户名，如adminpwd必选密码对应username的密码，md5(md5(登录密码)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,本页条数:10resultmsgdescriptionsuccessresult: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数组。json格式数据记录data的各属性定义：名称描述数据描述及范围例子uniqueId电话唯一标识ccic_dev_11-1334563616.70hotline热线号码numberTrunk中继号码customerNumber来电号码区号加七或八位的固话号码，区号与固话号码之间无-；或11位长度的手机号码。限国内固话或手机01059222999ustomerProvince来电省份北京customerCity来电城市北京numberTrunk中继号码6009queueName队列号0001cno座席工号1001clientNumber接听号码区号加七或八位的固话号码，区号与固话号码之间无-；或11位长度的手机号码。01041003149status接听状态座席接听mark标记1:留言 2:转移 3:咨询 4:三方 5:传真接收 6:会议 7:交互9:已进入IVR 10:未进入IVR 11:队列中放弃 12:队列中溢出留言startTime电话进入系统时间时间格式“yyyy-mm-ddhh:mm:ss”2012-05-01 15:00:02bridgeTime座席接听时间时间格式“yyyy-mm-ddhh:mm:ss”2012-05-01 15:00:12bridgeDuration通话时长格式“hh:mm:ss”00:02:26cost费用保留三位小数的有效小数0.600元totalDuration总时长格式“hh:mm:ss”00:02:36recordFile录音文件的最终地址及录音文件名详见下方说明20120813/3000001-20120813123014-01087125972-01041005966-record-ccic_dev_11-1344832214.2.mp3inCaseLib是否在案例库在/不在在score录音质检打分，0为未打分80callType呼叫类型普通呼入comment备注(应用mark参数)标记类型:标记的数据转移:座席号-1002ivrNameIVR名称默认自定义IVRendReason结束原因客户挂机userField自定义字段若需要使用此字段需联系技术人员测试sipCause呼叫结果0：无510：忙511：超时512：拒接513：空号514：关机515：暂时无法接听516：停机访问录音文件：若返回值中recordFile非空，则该通话有录音，在字符串前方加上http:/InterfaceServerIp:port/voices/record/，并在后面补充以下参数即可进行访问：参数要求描述备注hotline可选企业热线号码与enterpriseId二选一enterpriseId可选企业Id与hotline二选一userName必选用户名登录后台用户名，如adminpwd必选密码对应username的密码，md5(md5(登录密码)seed)，例如：md5(md5(123456)seed)，加密方式同通话记录接口seed必选自定字符串通话记录数据库同步接口发起者：合作方接受者：天润融通接口类型：HTTP接口调用方式：POST返回格式：JSON数据URL规范：http:/InterfaceServerIp:port/interfaceAction/cdrIbInterface!cdrIbDBCopy.actionInterfaceServerIp:port：天润融通接口服务器IP/域名及接收端口传入参数列表：参数要求描述备注hotline可选企业热线号码需要与enterpriseId二选一enterpriseId可选企业Id需要与hotline二选一userName必选用户名登录后台用户名，如adminpwd必选密码对应username的密码，md5(md5(登录密码)seed)，例如：密码为123456，seed为aaa首先md5(123456)= e10adc3949ba59abbe56e057f20f883e后接seed：e10adc3949ba59abbe56e057f20f883eaaa再次加密：md5(e10adc3949ba59abbe56e057f20f883eaaa)=d0782bdf141e366014b4bc0d7dc6ea00即为应传入的pwdseed必选随机字符串用于加密密码id必选数据表主键标识正整数，大于等于0，默认0，将从主键标识大于传入id的记录开始按id升序取出至多limit条记录。详见下方注释limit可选通话记录条数限制正整数，大于等于1，默认10，最大不能超过5000注：所有数据按平台编号，因此企业中通话记录的编号不一定是连续的，也不是从0开始。企业可以通过设置id=0获取本企业通话记录中最小的编号，之后自行更改为相应编号。例如，前一次最后一条取到的记录id=14340412，则在这次调用时，传入id=14340412，即可获得之后的数据，条数通过limit进行控制。注意后一条记录的id不一定为14340413。返回值：此接口返回JSON格式数据：“result”: 返回结果”,“msg”:“data”:通话记录数据,.,“totalCount”:“总记录数”resultmsgdescriptionsuccessresult:success,msg:data:id:626,unique_id:ccic_dev_11-1346319382.5,hotline:4006006001,number_trunk:6001,customer_number:01087125972,customer_number_type:1,customer_area_code:010,customer_province:北京,customer_crm_id:,customer_city:北京,customer_vip:0,client_number:,client_area_code:,client_name:,client_crm_id:,cno:,exten:,start_time:1346319382,answer_time:1346319382,join_queue_time:0,bridge_time:1346319387,end_time:1346319391,bill_duration:9,bridge_duration:4,total_duration:9,cost:0,ivr_id:15,ivr_name:根据按键选择转队列,ivr_flow:15|1|2|1346319383|1346319385,15|1.9|3|1346319385|1346319391,queue_name:,record_file:3000001-voicemail-ccic_dev_11-1346319382.5.mp3,score:0,score_comment:,in_case_lib:0,call_type:1,status:3,mark:1,mark_data:1,end_reason:1000,gw_ip:45,processed:0,”user_field”:”,”sip_cause”:0,create_time:2012-08-30 17:36:31,totalCount:1成功返回通话信息，其中data取值为json数组，包含指定条数的通话记录详细信息。error无权访问查询通话记录失败原因data字段中通话记录属性说明：名称（数据库字段名）数据描述及范围数据库格式例子id流水号(即数据库主键标识)，nextval(cdr_id_seq:regclass)integerNOT NULL DEFAULT 14340413uniqueId电话唯一标识character varyingccic_dev_11-1415170028.25060hotline热线号码character varying4006006000number_trunk中继号码character varying59051122customer_number主叫号码character varyinustomer_number_type主叫号码类型1-固话,2-手机integer1（说明主叫为固话）customer_area_code主叫地区character varying010customer_province主叫省份character varying北京customer_crm_id主叫在crm中的idcharacter varyingcustomer_city主叫地区城市character varying北京customer_vip客户vip级别，大于0为vipinteger DEFAULT 00（表示非VIP）client_number座席号码/被叫号码character varying01087120766client_area_code座席区号（仅在被叫为座席时非空）character varying010client_name座席名称（仅在被叫为座席时非空）character varyingclient_crm_id座席在crm中的idcharacter varying,cno座席编号（仅在被叫为座席时非空）character varying2002exten如果呼叫的分机，存入分机号character varyingstart_time客户进入系统时间，UNIX时间戳，即相对于January 1, 1970, 00:00:00 GMT的秒数bigint如：1333940942即：2012-04-09 11:09:02answer_time系统接听时间，UNIX时间戳bigintjoin_queue_time进入queue时间，UNIX时间戳bigintbridge_time座席应答时间，UNIX时间戳bigintend_time结束时间，UNIX时间戳bigintbill_duration计费时长，以秒计算integer DEFAULT 0如：84，即：1分24秒bridge_duration座席接听时长，以秒计算integer DEFAULT 0total_duration总通话时长，以秒计算integer DEFAULT 0cost费用（元）numeric(38,3) NOT NULLivr_idIVR资源idinteger1001ivr_nameIVR资源名称character varying默认自定义IVRivr_flowIVR流程格式为 ivrId1|path1|action1|start_time1|end_time1,ivrId2|path2|action2|start_time2|end_time2 系统设计最多经过ivr节点数为20次character varying1034|1|8|1415170166|1415170166,1034|1.1|13|1415170166|1415170175queue_name队列名（仅在被叫为座席时非空）character varyingrecord_file录音文件，文件名保存相对路径character varying3000001-voicemail-ccic_dev_11-1346319382.5.mp3score录音质检打分，0为未打分integer DEFAULT 00score_comment打分备注character varyingin_case_lib是否在案例库中，0:不在 1:在integer DEFAULT 0call_type1:呼入 2:web400呼入integer NOT NULLstatus1:座席接听 2:已呼叫座席，座席未接听 3:系统接听 4:系统未接-IVR配置错误 5:系统未接-停机 6:系统未接-欠费 7:系统未接-黑名单 8:系统未接-未注册 9:系统未接-彩铃10:网上400未接受 11:系统未接-呼叫超出营帐中设置的最大限制 12:其他错误integer NOT NULLmark标记 1:留言 2:转移 3:咨询 4:三方 5:传真接收 6:会议 7:交互9:已进入IVR 10:未进入IVR 11:队列中放弃 12:队列中溢出integer DEFAULT 0mark_data标记的数据：留言箱id；转移的数据-0,电话号码/1,座席号/2,分机/3,ivrId_nodePath；咨询的数据0,电话号码/1,座席号/2,分机号。支持多组用逗号分隔character varyingend_reason接听之后的挂机原因1000:客户挂机 1001:座席挂机 1002:被强拆 1-127:其他挂机原因integer DEFAULT 0gw_ip网关ipcharacter varying45processed是否处理过 0:未处理 1:已处理integer DEFAULT 0process_comment处理注释，可能为NULLcharacter varyinguser_field用户自定义字段（需使用此字段记录信息时请联系技术人员）character varyingsip_causeSIP响应码integer DEFAULT 0200create_time记录创建时间timestamp with time zone DEFAULT now()2012-04-09 11:09:03访问录音文件：若相应记录中record_file非空，则表示该通话有录音，在字符串前方加上http:/InterfaceServerIp:port/voices/record/yyyymmdd(年月日)，并在后面补充以下参数即可进行访问：参数要求描述备注hotline可选企业热线号码与enterpriseId二选一enterpriseId可选企业Id与hotline二选一userName必选用户名登录后台用户名，如adminpwd必选密码对应username的密码，md5(md5(登录密码)seed)，例如：md5(md5(123456)seed)，加密方式同通话记录接口seed必选自定字符串4. 示例通话记录接口查询某企业2012年8月9日18:00-19:00的前两条通话记录，限制条件为起始时间(startTime, endTime)和导出记录数(limit)：调用接口：90/interfaceAction/cdrIbInterface!listCdrIb.action?enterpriseId=3000001&userName=admin&pwd=d0782bdf141e366014b4bc0d7dc6ea00&seed=aaa&startTime=2012-08-09 00:00:00&endTime= 2012-08-09 19:00:00&start=0&limit=2返回：result:success,msg:data:uniqueId:ccic_dev_11-1344510702.21,customerNumber:01087125972,customerProvince:北京,customerCity:北京,numberTrunk:6001,queueName:0001,cno:2002,clientNumber:01041005968,status:座席接听,mark:,startTime:2012-08-09 19:11:42,bridgeTime:2012-08-09 19:12:21,bridgeDuration:00:00:10,cost:0.000,totalDuration:00:00:49,recordFile:20120809/3000001-20120809191142-01087125972-01041005968-record-ccic_dev_11-1344510702.21.mp3,inCaseLib:不在,score:0,callType:普通呼入,comment:无,ivrName:转咨询队列,endReason:座席挂机,uniqueId:ccic_dev_11-1344510632.19,customerNumber:01087125972,customerProvince:北京,customerCity:北京,numberTrunk:6001,queueName:0001,cno:2002,clientNumber:01041005968,status:座席接听,mark:,startTime:2012-08-09 19:10:32,bridgeTime:2012-08-09 19:10:44,bridgeDuration:00:00:34,cost:0.000,totalDuration:00:00:46,recordFile:20120809/3000001-20120809191032-01087125972-01041005968-record-ccic_dev_11-1344510632.19.mp3,inCaseLib:不在,score:0,callType:普通呼入,comment:无,ivrName:转咨询队列,endReason:客户挂机,paging:start:0,totalSize:9,pageSize:2其中包含录音文件：20120809/3000001-20120809191142-01087125972-01041005968-record-ccic_dev_11-1344510702.21.mp3则通过以下网址可以获得录音文件：90/voices/record/20120809/3000001-20120809191142-01087125972-01041005968-record-ccic_dev_11-1344510702.21.mp3?enterpriseId=3000001&userName=admin&pwd=d0782bdf141e366014b4bc0d7dc6ea00&seed=aaa通话记录数据库同步接口查询某企业编号(id)为14340412开始的两条（limit=2）通话数据: 调用接口：/interfaceAction/cdrIbInterface!cdrIbDBCopy.action?enterpriseId=3001136&userName=admin&pwd=75be84bf64f5de178eda060300aeec53&seed=aaa&id=14340412&limit=2获取的返回结果为：result:success,msg:data:id:14340413,unique_id:ccic_dev_11-1415170028.25060,hotline:59059141,number_trunk:59059141,customer_numbercustomer_number_type:2,customer_area_code:010,customer_province:北京,customer_crm_id:,customer_city:北京,customer_vip:0,client_number:,client_area_code:,client_name:,client_crm_id:,cno:,exten:,start_time:1415170028,answer_time:1415170039,join_queue_time:0,bridge_time:0,end_time:1415170039,bill_duration:0,bridge_duration:0,total_duration:11,cost:0,ivr_id:1034,ivr_name:两端呼测试,ivr_flow:1034|1|8|1415170039|1415170039,queue_name:,record_file:,score:0,score_comment:,in_case_lib:0,call_type:2,status:3,mark:9,mark_data:,end_reas