回调管理

街机捕鱼大富翁破解版 www.ywfxb.tw 若您初次使用智齿呼叫中心PAAS对接接口,请在使用前阅读说明文档

调用说明

请求及响应报文格式采用JSON格式。

SoftVersion是当前使用的REST API版本,不同版本会有差异,智齿api版本规范为:v1代表第一版,v2代表第二版,当前最新的版本为v1,在开发时需要注意填写正确。

对接URL

当前云通信平台对接地址为://www.ywfxb.tw/comm/

一、回调说明

请求方式

​ 回调统一设置为post方式,如需得到回调事件,请您提供一个接受post请求的url地址

推送说明

​ 当坐席状态发生变化或者通话状态发生变化的时候,能力开放平台会将相关的消息推送至第三方的回调地址,具体的消息类型如下表。

返回值说明

​ 任何时候回调接口返回200ok的状态码即视为成功回调

消息类型

公共推送参数:

参数名 含义
companyId 企业ID
appId 应用ID
msgType 消息类型

二、消息类型列表

消息类型 含义 备注
StartService 通话开始 呼入到达智齿系统或者呼出时开始呼叫
StopService 呼叫结束 整个通话结束
EnterQueue 进入排队 呼入未找到空闲坐席,进入排队
ExitQueue 退出队列 退出排队,可能是电话挂断或者分配到了空闲坐席
EvaluateResult 满意度评价 通话结束坐席挂断,客户做出满意度评价
IvrGiveUp Ivr放弃 客户呼入电话之后直接挂断,也没有进入技能组
OffWorkMsg 非服务时间 客户呼入时为ivr的非工作时间
PhoneStateConnected 电话接起 用户或者坐席的电话接起
PhoneStateAgentConnected 坐席电话接起 -
PhoneStateUserConnected 用户电话接起 -
PhoneStateDisConnected 电话挂断 用户或者坐席的电话挂断
PhoneStateExtError 坐席话机异常 呼叫坐席的电话时无法呼通
PhoneStateIdle 话机空闲 -
PhoneStateRing 话机振铃 -
PhoneStateAgentRing 坐席振铃 -
PhoneStateUserRing 用户振铃 -
AgentBreak 坐席强拆 -
AgentHangUp 监听中坐席挂断 -
AgentInsert 坐席监听中强插 -
MonitorCancer 监听取消 -
MonitorConnected 监听接通消息 -
MonitorRing 监听中振铃 -
UserHangUp 用户挂断 监听-强拆/强插过程中用户方挂断
AgentStateBusy 坐席状态忙碌 -
AgentStateException 坐席状态异常 -
AgentStateAfterWorking 坐席后处理 -
AgentStateIdle 坐席空闲 -
AgentStateTalking 坐席通话中 -
AgentStateLogOut 坐席离线 -
TransferConnected 转接接通 -

三、坐席状态回调

请求包体

属性 类型 说明
appId String 应用Id
companyId String 公司Id
agentId String 座席ID
changeTime String 状态切换时间,yyyymmddHHmiss
agentState String 坐席状态,忙碌,空闲,坐席状态,其中-1为离线,0为忙碌,1为空闲,3为通话接通中,115为后处理,99为异常

请求示例

{ 
    "companyId": "8a48b5514835561a01483e9149d803d8",
    "appId": "8a48b5514835561a01483e9149d803d8",
    "agentId": "xxx",
    "changeTime": "xxxxxxxxxxxxxx",
    "agentState": "1"
}

四、开始通话

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为StartService
callId String 用户呼叫id
agentId String 坐席id
agentGroupId String 技能组ID
agentName String 坐席名称
direction String 呼叫方向
extSatisfyType String 是否开启满意度 1为开启
groupType String 技能组类型
caller String 主叫
callee String 被叫
timestamp String 时间
numberProvice String 号码归属地-省
numberCity String 号码归属地-市

请求示例

{
    "agentGroupId": "aa0e6a0584044fc49d1231678942_1",
    "agentGroupName": "呼入客服组",
    "agentGroupType": "2",
    "agentid": "30aa6142dse802e4314c2859a",
    "appId": "8a216dacgytsf866b811185b",
    "callee": "03703737721",
    "caller": "05503564427",
    "callid": "ee450462-6acf-4244-8bd3-21kiy918225",
    "companyId": "aa0e6a05840mlout6d0d678942",
    "direction": "1",
    "extSatisfyType": 0,
    "groupType": "2",
    "messageNumber": 215271,
    "msgType": "StartService",
    "satisfyNumber": "-1",
    "numberProvice":"北京",
    "numberCity":"北京",
    "timestamp": "20190117114230215"
}

五、用户振铃

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为PhoneStateUserRing
callId String 用户呼叫id,当状态为2、3、由3变为0时,此值不为空。默认值为空。
agentId String 坐席id
caller String 主叫
callee String 被叫
numberProvice String 号码归属地-省
numberCity String 号码归属地-市

请求示例

{ 
    “companyId”:” 8a48b5514835561a01483e9149d803d8”,
    "appId": "8a48b5514835561a01483e9149d803d8",
    "callId": "xxx",
    "callee": "18645658308",
    "caller": "01086484075",
    "numberProvice":"北京",
    "numberCity":"北京",
    "msgType": "PhoneStateUserRing",
    “agentId”:”xxx”
}

六、坐席振铃

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为PhoneStateAgentRing
callId String 用户呼叫id
agentId String 坐席id
caller String 主叫
callee String 被叫
numberProvice String 号码归属地-省
numberCity String 号码归属地-市
direction String 呼叫方向,0为呼入,1为呼出

请求示例

{ 
    “companyId”:” 8a48b5514835561a01483e9149d803d8”,
    "appId": "8a48b5514835561a01483e9149d803d8",
    "callId": "xxx",
    "callee": "18645658308",
    "caller": "01086484075",
    "numberProvice":"北京",
    "numberCity":"北京",
    "direction":0
    "msgType": "PhoneStateAgentRing",
    “agentId”:”xxx”
}

七、坐席接通

请求包体

companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为PhoneStateAgentConnected
callId String 呼叫id
agentId String 坐席id
caller String 主叫
callee String 被叫
numberProvice String 号码归属地-省
numberCity String 号码归属地-市
direction String 呼叫方向,0为呼入,1为呼出

请求示例

{ 
    “companyId”:” 8a48b5514835561a01483e9149d803d8”,
    "appId": "8a48b5514835561a01483e9149d803d8",
    "callId": "xxx",
    "callee": "18645658308",
    "caller": "01086484075",
    "numberProvice":"北京",
    "numberCity":"北京",
    "direction":0
    "msgType": "PhoneStateAgentConnected",
    “agentId”:”xxx”
}

八、用户接听

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为PhoneStateUserConnected
callId String 用户呼叫id
agentId String 坐席id
caller String 主叫
callee String 被叫
numberProvice String 号码归属地-省
numberCity String 号码归属地-市

请求示例

{ 
    “companyId”:” 8a48b5514835561a01483e9149d803d8”,
    "appId": "8a48b5514835561a01483e9149d803d8",
    "callId": "xxx",
    "callee": "18645658308",
    "caller": "01086484075",
    "numberProvice":"北京",
    "numberCity":"北京",
    "msgType": "PhoneStateUserConnected",
    “agentId”:”xxx”
}

九、通话结束

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为StopService
callid String 用户呼叫id
agentGroupId String 呼叫所属技能组ID
agentGroupName String 呼叫所属技能组名称
caller String 主叫
callee String 被叫
direction String 呼叫方向,0为呼入,1为呼出
duration integer 有效通话时长
timestamp String 时间
voiceAliyunUrl String 录音地址
agentId String 坐席id
numberProvice String 号码归属地-省
numberCity String 号码归属地-市

请求示例

{
    "agentGroupId": "a4b2c401c19e4b8e8e79bbd435c9",
    "agentGroupName": "管理团队",
    "agentGroupType": "3",
    "agentid": "2259b2a30d914e31bd0cb81cac27e5d3",
    "appId": "8aaf070863b526a40163c8c01bc60a8e",
    "callee": "18645658308",
    "caller": "01086484075",
    "callid": "45b3b81f-791c-4a5f-b40c-cac25183f",
    "companyId": "a4b2c401c19eebw29bbd435c978a0",
    "direction": "1",
    "duration": 0,
    "numberProvice":"北京",
    "numberCity":"北京",
    "extSatisfyType": 0,
    "groupType": "3",
    "messageNumber": 195837,
    "msgType": "StopService",
    "satisfyNumber": "-1",
    "timestamp": "20190117112823492",
    "voiceAliyunUrl": ""
}

十、满意度评价

请求包体

属性 类型 说明
companyId String 企业ID
appId String 应用Id
msgType String 消息类型,此处为PhoneStateUserConnected
callId String 用户呼叫id,当状态为2、3、由3变为0时,此值不为空。默认值为空。
agentId String 坐席id
agentGroupId String 技能组ID
agentName String 坐席名称
direction String 呼叫方向
extSatisfyType String 是否开启满意度 1为开启
fromattr String 主叫归属地
groupType String 技能组类型
caller String 主叫
callee String 被叫
satisfyLevel String 满意度等级 2:两级 3:三级,5:五级
satisfyNumber String 满意度按键
timestamp String 时间

请求示例

{
    "agentGroupId": "6b0132ff7eff4d5aa82835107951c0376_1",
    "agentName": "测试",
    "agentid": "060f0cca6b52wj8361424c6b7199",
    "appId": "8aaf0alpou15d399fc1140f38",
    "callee": "01062051663",
    "caller": "15270887626",
    "callid": "b1e70752-1a08-11e9-acf3-8f81eltred5",
    "companyId": "6b0132ffvmsytn207951c0376",
    "direction": "0",
    "extSatisfyType": 1,
    "fromattr": "江西|南昌",
    "groupType": "2",
    "messageNumber": 206755,
    "messageType": "evaluateresult",
    "msgType": "EvaluateResult",
    "satisfyLevel": "2",
    "satisfyNumber": "1",
    "startTime": "1547696044188",
    "timestamp": "20190117113559767"
}

results matching ""

    No results matching ""