通话事件推送

注意:事件推送请求默认都为post,接收到平台推送后,需要在8s内返回json格式,{"code": "200"},否则都视为推送失败,会有重推逻辑。重推时间:10s,30s,60s,600s,3600s。

1、通话记录推送

字段名称字段类型字段描述
pushTypestring推送类型,通话记录推送为固定值"cdr"
accountIdstring账户编号
agentNamestring座席名称
agentNumberstring座席工号
loginTypestring座席外呼方式。PSTN/sip/WEBRTC
startTimestring呼叫开始时间
agentAnswerTimestring座席接通时间
customerRingTimestring客户振铃时间
agentRingTimeString座席振铃时间
agentRingDuration Long座席振铃时长
customerRingDurationLong客户振铃时长
answerTimestring接通时间
hangupTimestring挂机时间
callDurationInteger通话时长 挂机时间-接通时间
endTimestring呼叫结束时间
callIdstring通话ID
callIdFrom string转接到该通话的通话记录id
transferFrom string转接到该通话的座席工号
recordUrlstring通话录音文件地址
leaveMsgUrlstring留言录音文件地址
consultRecordUrlstring咨询录音文件地址
extras json自定义参数(与软电话条,外呼接口,双向呼叫接口,ivr对接配合使用)。注:在云客服系统ivr中新增extras_abc的变量,如进行赋值后,会在extras里新增变量abc。
callTypestring通话类型,呼入:'callin', 外呼:'callout', 双向呼叫:'twoWayCall', 智能外呼:'autoCallout', 外呼任务:'callTask', 咨询:'consult', 转接:'transfer', 咨询转接:'consultTransfer'
customerNumberstring客户号码,来电是主叫号码,去电是被叫号码
customerProvincestring客户省份
customerCitystring客户城市
disNumberstring外显号,去电的主叫号码
disProvincestring外显号省份
disCitystring外显号城市
serviceNumberstring服务号,来电的被叫号码
queueNamestring技能组名称
queueNumberstring技能组编号
inQueueTimestring进入队列时间
queueDurationInteger技能组排队等待时长 呼叫座席的时间-进入队列的时间
eventIdstring事件唯一ID
failReasonstring失败原因Key,如“32”。
failReasonMsgstring失败原因值,如“线路黑名单”。
hangUpPartystring挂机方 'CUSTOMER'客户, 'AGENT'坐席, 'SYSTEM'系统
satisfyStartTimestring满意度调查开始时间
satisfyEndTimestring满意度调查结束时间
satisfyDurationInteger满意度调查时长 满意度结束时间-满意度开始时间
satisfyKeysstring满意度按键值记录
statusstring通话状态:'CCR_LIMIT':并发限制,'BLACK_LIMIT'黑名单限制,'ANSWER'已接听,'IVR'语音导航中挂机, 'QUEUE_ABANDON'排队放弃,'LEAVE_MSG'留言,'AGENT_NO_ANSWER'坐席未接听,'CUSTOMER_NO_ANSWER'客户未接听,'THREE_WAY_CALL':三方,'TRANSFER'呼叫转移,'CONSULT'咨询已接听,'CONSULT_TRANSFER': 咨询转移
numberGroupIdstring外显号码组id(通话座席配置有外显号码组时才会有该参数)
numberGroupNamestring外显号码组名字(通话座席配置有外显号码组时才会有该参数)
premediaFileUrlstring前媒体录音地址,当通话非answer状态时,会推送该地址
附录1 失败原因对应表
编码名称描述
32线路黑名单lineBlackList
通话记录推送示例
{ "consultRecordUrl":"", "callDuration":14, "satisfyKeys":"1_0", "serviceNumber":"222222", "transferFrom":"", "answerTime":"2023-06-27 21:20:17", "inQueueTime":"", "disCity":"北京", "extras":"", "callIdFrom":"", "satisfyEndTime":"2023-06-27 21:20:31", "customerCity":"北京", "callType":"callin", "failReason":"", "hangupTime":"2023-06-27 21:20:31", "startTime":"2023-06-27 21:20:02", "hangUpParty":"AGENT", "satisfyDuration":9, "callId":"686107815951998976", "eventId":"fc1879bfd8864263aa436b7c611854c3", "recordDuration":0, "recordUrl":"https://useasy-oss.oss-cn-hangzhou.aliyuncs.com/1090/20230627/1090-20230627212012-8124-6861078159519.wav", "customerProvince":"北京", "agentName":"测试", "leaveMsgUrl":"", "agentNumber":"2222", "customerNumber":"1231231231", "disProvince":"北京", "accountId":"2222", "queueName":"", "queueDuration":0, "disNumber":"12312312", "queueNumber":"", "endTime":"2023-06-27 21:20:31", "satisfyStartTime":"2023-06-27 21:20:22", "status":"ANSWER" }

2、通话事件推送

字段名称字段类型字段描述
pushTypestring推送类型,外呼振铃事件:"dialoutRing",外呼挂机事件:"dialoutHangup",来电振铃事件:"incomingRing",来电挂机事件:"incomingHangup",客户接通事件:"link"
eventIdstring事件唯一ID
accountIdstring账户编号
agentNumberstring座席工号
callIdstring通话ID
eventTypestring事件类型:呼叫:calling,振铃:ring,接通:link,挂机:hangup
eventTimestring事件发生时间,时间戳
customerNumberstring客户号码,来电是主叫号码,去电是被叫号码
customerProvincestring客户省份
customerCitystring客户城市
callTypestring通话类型,呼入:'callin', 外呼:'callout', 双向呼叫:'twoWayCall', 智能外呼:'autoCallout', 外呼任务:'callTask', 咨询:'consult', 转接:'transfer', 咨询转接:'consultTransfer'
serviceNumberstring服务号,来电的被叫号码
disNumberstring外显号,去电的主叫号码
queueNumberstring技能组编号
extrasstring自定义参数(与软电话条,外呼接口,双向呼叫接口,ivr对接配合使用)。注:在云客服系统ivr中新增extras_abc的变量,如进行赋值后,会在extras里新增变量abc。
通话事件推送示例
{ "callId":"686107815951998976", "eventId":"42f7c8bc2baa4734a7041ff7660e4bcf", "serviceNumber":"111111111", "customerProvince":"北京", "extras":"", "agentNumber":"1111", "customerCity":"北京", "eventType":"hangup", "customerNumber":"111111111", "callType":"callin", "accountId":"1090", "disNumber":"1111111", "eventTime":"1111111", "queueNumber":"" }

3、录音推送

字段名称字段类型字段描述
pushTypestring推送类型,录音推送为固定值"record"
callIdstring通话ID
accountIdstring账户编号
eventIdstring事件唯一ID
recordUrlstring录音地址
customerUrlstring客户侧录音url,仅限于开启录音双轨多文件时推送
agentUrlstring座席侧录音url,仅限于开启录音双轨多文件时推送
推送示例
{     "callId":"757848663911174144",    "accountId":"1019",     "eventId":"757848716492886016",     "recordUrl":"https://useasy-prod.oss-cn-hangzhou.aliyuncs.com/1019/20240111/1019-20240111203222-02867762691-18616379628-8666-757848663911174144-s-mix.mp3",    "customerUrl":"https://useasy-oss.oss-cn-hangzhou.aliyuncs.com/1090/20240125/1090-20240125191145-02862280304-18616379628-80100-762901804519686144-s-in.mp3","eventId":"762901981898674176",    "agentUrl":"https://useasy-oss.oss-cn-hangzhou.aliyuncs.com/1090/20240125/1090-20240125191145-02862280304-18616379628-80100-762901804519686144-s-out.mp3" }  

4、录音文本推送事件

如开启账号通话实时转写或通话录音转写都可触发此事件。
字段名称字段类型字段描述
pushTypestring推送类型,录音文本推送为固定值"recordText"
callIdstring通话ID
accountIdstring账户编号
eventIdstring事件唯一ID
recordTextList录音文本
eventTypestringrealTime:实时转写文本,offline:通话录音转写文本
callDurationint通话时长,只有realTime才推送
callTypestring 通话类型,只有realTime才推送
agentNumberstring通话座席工号,只有realTime才推送
推送示例:
{ "accountId": "1090", "callId": "780620108113129472", "eventId": "780620179906621440", "eventType": "realTime", "recordText": [ { "side": "customer", "text": "测试" }, { "side": "agent", "text": " hello Hello,1234" }, { "side": "customer", "text": ". 1234喂喂喂" }, { "side": "customer", "text": " Hello. Hello" }, { "side": "customer", "text": "嗯" } ] }

5、坐席状态推送

字段名称字段类型字段描述
accountIdstring账户编号
agentNumberstring座席工号
eventIdstring事件唯一ID
eventTimestring状态开始时间,时间戳
stateNamestring坐席状态名称
stateNumberstring坐席状态编号,0:空闲、1:忙碌、2:呼叫中、3:振铃、4:通话中、5:话后处理

6、坐席登陆事件

字段名称字段类型字段描述
eventIdstring事件唯一ID
eventTypestring事件类型:登录:login,登出:logout
eventTimestring事件发生时间,时间戳
accountIdstring账户编号
agentNumberstring座席工号
loginTypestring坐席登录类型(PSTN、WEBRTC、SIP)
offlineAnswerboolean登出时是否离线接听,true:离线接听,false:不离线接听
offlineAnswerTypestring离线接听方式:PSTN、SIP
2024-11-28