华为云用户手册

  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/queryconfinfos 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 呼叫到达通知事件 标示符 AgentEvent_Incoming_CallInfo 作用 用户呼入场景,提醒座席有会话进入。 附带信息 callId表示呼叫唯一标记。 skillName表示技能队列名称 skillId表示技能队列ID caller表示主叫号码 called表示被叫号码 lastReleaseAgentId表示最后一次释放该呼叫的座席ID mediaType表示媒体类型 releaseAndReQueueCount表示被座席释放并重路由次数 releaseAndReQueueCallFlag表示当前呼叫是否为被座席释放后重路由呼叫。0:不是,1:是。 示例: {"eventType": "AgentEvent_Incoming_CallInfo","workNo": "56020","content": {"callId": "1669951418-12166","skillName": "defaultVideoSkill","skillId": 1, "caller": "88880165","called": "310300","lastReleaseAgentId": 65535,"mediaType": 19,"releaseAndReQueueCount": 0,"releaseAndReQueueCallFlag": 0}} 父主题: 音视频通话事件
  • 会议申请成功 标示符 AgentConf_RequestSuccess 作用 表示会议申请成功,同时主席已经加入会议。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_RequestSuccess","workNo":"153","content":{"confId":1030400}}} 父主题: 座席会议事件
  • H5接入信息事件 标示符 AgentEvent_RequestConnect 作用 表示上报H5接入信息事件 附带信息 workNo:座席号。 content:消息对象,JSON格式。包含字段如下: callid:呼叫标识。 userId:坐席工号。 ctime:过期时间。 channelId:频道ID(房间ID)。 role:角色。 ip:媒体服务器接入点IP地址。 port:媒体服务器接入点端口。 signalingDomainIn:内侧信令domain。 signalingDomainOut:外侧信令domain。 locationId:节点。 signature:签名。 appId:用户标识。 示例: {"message":"","retcode":"0","event":{"eventType":" AgentEvent_RequestConnect","workNo":"49999","content":{ "userId": "坐席工号","ctime": "过期时间","channelId": "15945185-345","appId": "8345234631", "ip": "xxx.xxx.xxx.xxx","port": "6500","role": "0","signalingDomainIn": "https: //in.isdpdomain.com","signalingDomainOut": "https: //out.isdpdomain.com","locationId": "65535","signature": "xxx","appId": "sdcp0BPcVGymItWppGX6XqrZGTCYa13d"}}} 父主题: 多媒体事件
  • 会议申请失败 标示符 AgentConf_RequestFailed 作用 表示会议申请失败。 附带信息 cause表示失败原因码。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_RequestFailed","workNo":"153","content":{"cause":21234}}} 父主题: 座席会议事件
  • 会议超时提醒事件 标示符 AgentConf_Timeout 作用 会议申请成功后开始计时,当会议剩余时间到达设置的提示时间点时,将触发该事件。 座席在收到该事件后选择是否延长会议时间,如果不做延时操作,当会议到达结束时间点后就会被释放。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_Timeout","workNo":"153","content":{"confId":1030656}}} 父主题: 座席会议事件
  • 自己加入会议事件 标示符 AgentConf_SelfJoinResult 作用 表示当前座席已经加入会议。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_SelfJoinResult","workNo":"153","content":{"confId":1030400}}} 父主题: 座席会议事件
  • H5截图事件 标示符 AgentEvent_ImageCapture 作用 表示H5截图结果事件 附带信息 workNo:座席号。 content:消息对象,JSON格式。包含字段如下: callid:呼叫标示。 filename:截图文件地址。 locationId:截图文件对应的节点ID。 result:截图结果,0表示成功,1表示失败,2表示用户拒绝。 示例: {"eventType": "AgentEvent_ImageCapture","workNo": "1002","content": {"callid": "1654917192-17845843","result": 0,"filename": "F:/5/1/20220611/1002/1113201.jpg","locationId": 256}} 父主题: 多媒体事件
  • 会议放音结束事件 标示符 AgentConf_StopVoice 作用 表示会议放音结束。 附带信息 result表示停止会议放音的结果。0:成功 1:失败。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_StopVoice","workNo":"154","content":{"result":0}}} 父主题: 座席会议事件
  • 自己离开会议事件 标示符 AgentConf_SelfLeaveResult 作用 表示当前座席离开会议。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_SelfLeaveResult","workNo":"153","content":{"confId":1030400}}} 父主题: 座席会议事件
  • 主席变更事件 标示符 AgentConf_PresidentChanged 作用 表示当前座席被变更为会议主席。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_PresidentChanged","workNo":"154","content":{"confId":1031168}} 父主题: 座席会议事件
  • 与会者变更事件 标示符 AgentConf_ParticipantChanged 作用 被邀请座席将收到此事件。 附带信息 result表示变更结果。0:成功;其他:失败。 changeType表示变更类型。0:加入会议;1:退出会议;2:主席变更;3:禁止发言;4:恢复发言;5:保持;6:取消保持。 changeReason表示变更原因,当“ChangeType”为“1”时,此参数有意义,“ChangeType”为其他类型时无意义。0:参与者主动离开会议;1:会议主席强制移除与会者;2:与会者挂机;3:会议结束;4:与会座席签出;6:其他原因导致与会者被强制离开会议 confId表示会议ID。 participant表示会议成员标识。 participantType表示会议成员类型。6:电话号码;9:座席工号。 deviceCallType表示自定义的设备呼叫类型。 deviceType表示自定义的设备类型。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_ParticipantChanged","workNo":"154","content":{"result":0,"changeReason":255,"changeType":3,"confId":1031168,"participant":"154","participantType":9,"deviceCallType":0,"deviceType":0}}} 父主题: 座席会议事件
  • 网页客户端接入 若网页端客户接入接口返回401,说明请求头中Authorization或ccmessaging-token已失效,需先调用C1 系统配置类接口鉴权方式刷新Authorization,调用第三方请求鉴权(applyToken)接口刷新cccmessaging-token后,再调用业务接口。 第三方请求鉴权 (applyToken) 查询排队信息 (queryQueueInfo) 主动轮询座席侧发送的信息 (poll) 提交客户满意度评价结果 (saveSatisfaction) 发送消息 (send) 客户发送文件 (uploadFileStream) 客户接收文件 (downloadFileStream) 根据客户输入联想常用语 (queryPhraseByKeyword) 检查当前租间是否支持点击通话 (checkClickToCallSupport) 创建点击通话 (createClickToCall) 获取点击通话事件 (getClickToCallEvents) 释放点击通话 (dropClickToCall) 创建匿名通话 (createcall) 客户提交留言 (doLeaveMessage) 提交客户对机器人满意度评价结果 (feedbacksatisfaction) 查询历史消息 (queryHistoryChatMessage) 丢弃邮件(chat_dropMail) 提供whatsapp发送下行消息(sendWhatsappMessage) 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)
  • 会议通道放音结束事件 标示符 AgentConf_StopParticipantVoice 作用 表示会议通道放音结束。 附带信息 result表示停止会议放音的结果。0:成功 1:失败。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_StopParticipantVoice","workNo":"154","content":{"result":0}}} 父主题: 座席会议事件
  • 转出通知 标示符 AgentEvent_linkagePhoneTransferOut 作用 表示座席正在通过话机转出当前呼叫。 附带信息 addrOut:表示被转出的电话号码。 addrSelf:表示座席的电话号码。 address:表示地址标识。 addressType:表示地址类型(当前只会为6,表示电话号码)。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneTransferOut","workNo":"120","content":{"addrOut":{"address":"70002","addressType":6},"addrSelf":{"address":"70001","addressType":6}}}} 父主题: 话机联动事件
  • 取消静音 标示符 AgentEvent_linkagePhoneUnMute 作用 表示某个呼叫被话机取消静音。 附带信息 callId:表示被取消静音的呼叫的唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneUnMute","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题: 话机联动事件
  • 联动能力 标示符 AgentEvent_linkageCapability 作用 表示某个座席话机联动是否成功。 附带信息 result表示联动结果,0表示联动成功,其他表示失败。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkageCapability","workNo":"120","content":{"result":0}}} 父主题: 话机联动事件
  • 保持 标示符 AgentEvent_linkagePhoneHold 作用 表示某个呼叫被话机保持。 附带信息 callId:表示被保持的呼叫的唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneHold","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题: 话机联动事件
  • 静音 标示符 AgentEvent_linkagePhoneMute 作用 表示某个呼叫被话机静音。 附带信息 callId:表示被静音的呼叫的唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneMute","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题: 话机联动事件
  • 转出结果通知 标示符 AgentEvent_linkagePhoneTransferOut_Result 作用 表示话机联动转出的结果。 附带信息 result:0表示转出成功,其他表示失败。 callId:表示联动转出的呼叫唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneTransferOut_Result","workNo":"130","content":{"result":1138,"callId":"1481881644-21"}}} 父主题: 话机联动事件
  • 订阅语音识别结果接口通用返回结果码 结果码 说明 0 调用配置接口成功 107-000 缓存登录信息失效,需要重新登录鉴权 107-001 调用配置接口抛了异常 107-002 输入参数不合法,必填字段为空 107-003 配置管理员密码错误,重试多次后锁定账号 107-004 无效配置管理员账号 107-005 配置接口通信失败 107-007 配置接口配置前鉴权失败 107-026 订阅失败异常 107-027 订阅登记失败异常 107-028 订阅请求失败异常 107-029 订阅请求超时异常 107-030 订阅异常 107-031 订阅注销失败异常 107-032 订阅握手失败异常 107-049 识别结果推送获取流程接入码失败异常码 107-050 识别结果推送获取servicetoken失败异常码 107-051 识别结果推送 servicetoken 无效异常码 107-052 识别结果推送失败异常码 107-053 识别结果推送请求异常码 107-054 识别结果推送请求超时异常码 107-055 ODFS 会话初始化异常码 107-056 ODFS 会话交互异常码 107-057 ODFS 断开连接异常码 父主题: 错误码定义
  • 取消保持 标示符 AgentEvent_linkagePhoneUnHold 作用 表示某个呼叫被话机取消保持。 附带信息 callId:表示被取消保持的呼叫的唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneUnHold","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题: 话机联动事件
  • 接口概述 云客服系统对外开放的接口主要分为如下几类,您可以参照表1了解几个主要的接口类别和基本功能,可以参照表2快速查找到您需要的具体某一个接口。 部分接口包含分布式锁,用于保证在并发场景下,同一段时间只能处理一个座席的修改/新增请求,防止原子性和一致性被破坏。接口调用时触发分布式锁,接口调用完成(不论失败还是成功)后分布式锁自动释放,接口可以二次调用。 表1 接口概览 接口类别 描述 呼叫中心配置接口 包含座席管理、技能队列管理、号码管理、IVR管理相关接口。 可以通过这类接口创建座席和技能队列,查询座席、技能队列、接入码和IVR流程相关信息,上传IVR语音文件等。 座席工作台接口 包含座席控制、座席双呼(移动APP场景下使用)、订阅语音识别结果接口、App个人设置(移动APP场景下使用)。 可以通过这类接口实现座席签入签出和呼叫控制,查询呼叫数据,座席双呼,以及向呼叫中心CTI平台发起语音识别结果订阅。 使用座席工作台的相关接口,您还需要考虑话机的相关使用,具体请参见《开发指南》。 电销外呼接口 即CC-iSales(电销外呼)的接口。 可以通过这类接口实现新增外呼活动、添加外呼号码、查询外呼结果等业务。 机器人管理接口 即OIAP(智能助手平台)的接口。 可以通过这类接口实现查询领域、对话、管理问答、管理问答组等业务。 网页客户端接入接口 即网页客户端接入的接口。 可以通过这类接口实现用户发送在线消息,发送与接收文件,发起点击通话等业务。 质检/监控/统计类接口 包含实时质检、查询实时数据、历史数据、和配置类数据的接口。 可以通过这类接口实现质检员对座席进行插入、侦听、拦截等实时质检操作,查询租间的座席、技能队列等不同维度的实时监控指标和历史监控指标等。 须知: 在监控、统计类接口中,如果出现如下结构的描述,是为了兼容历史版本。当前版本返回结果码使用resultCode替代result,接口返回数据使用 resultDesc替代resultDatas。 result:查询结果。数据类型为String, 取值如下: 0:成功 非0:失败 resultDatas:查询成功后,返回结果信息的JSON对象数组。 录音/话单类接口 包含录音回放、录音下载、视频下载、话单下载相关接口。 可以通过这类接口实现座席签入后给座席播放录音、座席侧下载音视频文件、第三方下载话单和下载以及播放录音等。 语音通知接口 包含查询语音通知的录音文件、创建语音通知接口。 可以通过这类接口可以发起语音通知,向指定客户播放指定语音文件。 工单接口 包含创建工单接口与任务接口。 表2 详细接口列表 接口分类一级目录 接口分类二级目录 接口名称 请求URL 接口鉴权方式 呼叫中心配置类接口 座席管理 创建座席账号 https://域名/apiaccess/rest/cc-management/v1/agentAccount/create C1 系统配置类接口鉴权方式 删除指定座席账号 https://域名/apiaccess/rest/cc-management/v1/agentAccount/delete 修改座席账号信息 https://域名/apiaccess/rest/cc-management/v1/agentAccount/update 查询座席账号信息 https://域名/apiaccess/rest/cc-management/v1/agentAccount/query 绑定座席和技能队列 https://域名/apiaccess/rest/cc-management/v1/agentAccount/addSkillsToAgent 解绑座席和技能队列 https://域名/apiaccess/rest/cc-management/v1/agentAccount/releaseAgentBySkillId 修改座席软电话号码登录密码 https://域名/apiaccess/rest/cc-management/v1/sipPhone/updateSipPhonePassword 依据技能队列ID查询座席信息 https://域名/apiaccess/rest/cc-management/v1/agentAccount/queryAgentInfoBySkillId 查询所有座席的软电话信息(不包含业务账号) https://域名/apiaccess/CC-Mangemant/v1/querySysInfo 查询所有座席的软电话信息(包含业务账号) https://域名/apiaccess/CC-Mangemant/v1/queryAgentInfo 查询账号登录结果 https://域名/apiaccess/CC-Management/v1/queryAgentLoginParams 技能队列管理 创建技能队列 https://域名/apiaccess/rest/cc-management/v1/skill/createSkill C1 系统配置类接口鉴权方式 删除技能队列 https://域名/apiaccess/rest/cc-management/v1/skill/deleteSkill 修改技能队列 https://域名/apiaccess/rest/cc-management/v1/skill/modifySkill 查询技能队列 https://域名/apiaccess/rest/cc-management/v1/skill/querySkills 获取所配置技能队列排队总人数 https://ip:port/agentgateway/resource/queuedevice/{agentid}/waitnum C4 座席操作类接口鉴权方式 获取已签入技能队列排队人数 https://ip:port/agentgateway/resource/queuedevice/{agentid}/waitnumbyagent 获取座席所在VDN技能队列信息 https://ip:port/agentgateway/resource/queuedevice/{agentid}/agentvdnskill 获取指定技能队列排队总人数 https://ip:port/agentgateway/resource/queuedevice/{agentid}/skillwaitnum/{skillid} 查询一组技能队列统计信息 https://ip:port/agentgateway/resource/queuedevice/{agentid}/queryacdstat 查询座席所在VDN的IVR信息 https://ip:port/agentgateway/resource/queuedevice/{agentid}/ivrinfo 查询签入技能队列座席详细信息 https://ip:port/agentgateway/resource/agentgroup/{agentid}/agentbyskill/{skillid} 查询指定座席详细座席信息 https://ip:port/agentgateway/resource/agentgroup/{agentid}/agentbyworkno/{workno} 查询签入技能队列所有在线座席详细信息 https://ip:port/agentgateway/resource/agentgroup/{agentid}/allonlineagents 号码管理 查询指定租间的接入码 https://域名/apiaccess/rest/cc-management/v1/accessCodeInfo/queryAccessCodeList C1 系统配置类接口鉴权方式 单个创建接入码与技能队列、IVR绑定关系的接口 https://域名/apiaccess/rest/cc-management/v1/calledRoute/createCalledRoute 删除接入码与技能队列、IVR绑定关系的接口 https://域名/apiaccess/rest/cc-management/v1/calledRoute/deleteCalledRoute 单个修改接入码与技能队列、IVR绑定关系的接口 https://域名/apiaccess/rest/cc-management/v1/calledRoute/modifyCalledRoute 查询接入码与技能队列、IVR绑定关系的接口 https://域名/apiaccess/rest/cc-management/v1/calledRoute/queryCalledRoute 查询号码归属地 https://域名/apiaccess/rest/cc-management/v1/phonearea/getPhoneNoRegionInfo IVR流程 查询指定租间的所有IVR流程 https://域名/apiaccess/rest/cc-management/v1/ivrFlow/queryIVRFlowList C1 系统配置类接口鉴权方式 查询满意度调查的IVR流程 https://域名/apiaccess/rest/cc-management/v1/satisfactionconfig/querySatifyConfig 查询满意度调查结果 https://域名/apiaccess/rest/cc-management/v1/satisfaction/query 上传IVR语音文件 https://域名/apiaccess/rest/cc-management/v1/importVoiceFile/upload 座席工作台接口 座席控制: 座席操作类 签入 https://ip:port/agentgateway/resource/onlineagent/{agentid} C4 座席操作类接口鉴权方式 强制签入 https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogin 座席心跳接口 https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake 发送便签接口 https://ip:port/agentgateway/resource/onlineagent/{agentid}/sendnoteletex 查询配置技能队列 https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskills 查询指定座席配置技能队列 https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} 设置是否自应答 https://ip:port/agentgateway/resource/onlineagent/{agentid}/autoanswer/{isautoanswer} 重置技能队列 https://ip:port/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage} 示闲 https://ip:port/agentgateway/resource/onlineagent/{agentid}/sayfree 示忙 https://ip:port/agentgateway/resource/onlineagent/{agentid}/saybusy?reason={reason} 取消示忙 https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelbusy 请求休息 https://ip:port/agentgateway/resource/onlineagent/{agentid}/rest/{time}/{restcause} 取消休息 https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelrest 进入工作态 https://ip:port/agentgateway/resource/onlineagent/{agentid}/work 退出工作态 https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelwork 修改密码(扩展) https://ip:port/agentgateway/resource/onlineagent/{agentid}/modifyaccountpwdex 设置是否进入空闲态 https://ip:port/agentgateway/resource/onlineagent/{agentid}/autoenteridle/{flag} 签出 https://ip:port/agentgateway/resource/onlineagent/{agentid}/logout 强制签出 https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogout 强制签出带原因码 https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogoutwithreason/{reason} 获取当前座席的状态 https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentstatus 设置是否接听来话 https://ip:port/agentgateway/resource/onlineagent/{agentid}/settalkright?flag={flag} 座席签入平台接口 https://ip:port/agentgateway/resource/onlineagent/{agentid}/loginex 座席页面刷新时主动请求更新Guid https://ip:port/agentgateway/resource/onlineagent/{agentid}/updateGuid 座席页面刷新时同步座席状态status和通话信息 https://ip:port/agentgateway/resource/onlineagent/{agentid}/syncagentinfo 座席控制: 呼叫控制类 外呼 https://ip:port/agentgateway/resource/voicecall/{agentid}/callout C4 座席操作类接口鉴权方式 预览外呼 https://ip:port/agentgateway/resource/voicecall/{agentid}/previewCallout 呼叫应答 https://ip:port/agentgateway/resource/voicecall/{agentid}/answer?{callid=XXXX} 内部呼叫 https://ip:port/agentgateway/resource/voicecall/{agentid}/callinner 内部求助 https://ip:port/agentgateway/resource/voicecall/{agentid}/innerhelp 静音 https://ip:port/agentgateway/resource/voicecall/{agentid}/beginmute 取消静音 https://ip:port/agentgateway/resource/voicecall/{agentid}/endmute 呼叫保持 https://ip:port/agentgateway/resource/voicecall/{agentid}/hold 连接保持 https://ip:port/agentgateway/resource/voicecall/{agentid}/connecthold/{callid} 取消保持 https://ip:port/agentgateway/resource/voicecall/{agentid}/gethold?callid={callid} 呼叫转移 https://ip:port/agentgateway/resource/voicecall/{agentid}/transfer 取消转移 https://ip:port/agentgateway/resource/voicecall/{agentid}/canceltransfer 二次拨号(扩展) https://ip:port/agentgateway/resource/voicecall/{agentid}/seconddialex?number={number} 三方通话 https://ip:port/agentgateway/resource/voicecall/{agentid}/confjoin 拆除指定callid呼叫 https://ip:port/agentgateway/resource/voicecall/{agentid}/dropcall/{callid} 挂断呼叫 https://ip:port/agentgateway/resource/voicecall/{agentid}/release 释放指定号码连接 https://ip:port/agentgateway/resource/voicecall/{agentid}/disconnect/{number} 音视频切换 https://ip:port/agentgateway/resource/voicecall/{agentid}/mediaswitch?mediaType=3 控制三方视频通话图像展示模式 https://ip:port/agentgateway/resource/voicecall/{agentid}/adjustvideomode 请求指定呼叫 https://ip:port/agentgateway/resource/voicecall/{agentid}/requestcall/{callid}/{skilltype}?skillId={skillId} 手机接听 https://域名/apiaccess/rest/cc-management/v1/offline/agent/login C1 系统配置类接口鉴权方式 退出手机接听 https://域名/apiaccess/rest/cc-management/v1/offline/agent/logout 查询指定座席是否为手机接听状态 https://域名/apiaccess/rest/cc-management/v1/offline/agent/isOfflineAgent 座席控制: 呼叫数据 查询呼叫信息 https://ip:port/agentgateway/resource/calldata/{agentid}/callinfo?isNoContainLastCall={isNoContainLastCall} C4 座席操作类接口鉴权方式 查询呼叫随路数据 https://ip:port/agentgateway/resource/calldata/{agentid}/appdata?isEncodeResult={isEncodeResult} 设置呼叫随路数据(扩展) https://ip:port/agentgateway/resource/calldata/{agentid}/setcalldataex 查询保持列表 https://ip:port/agentgateway/resource/calldata/{agentid}/holdlist 查询应答来话前呼叫信息 https://ip:port/agentgateway/resource/calldata/{agentid}/callinfobeforeanswer 根据呼叫CallID查询呼叫信息 https://ip:port/agentgateway/resource/calldata/{agentid}/callinfobycallid/{callid} 查询指定座席呼叫ID https://ip:port/agentgateway/resource/calldata/{agentid}/allcallinfoEx/{workno} 查询座席当前的话路数 https://ip:port/agentgateway/resource/calldata/{agentid}/callnums 查询座席当前呼叫统计信息 https://ip:port/agentgateway/resource/calldata/{agentid}/statistics 查询指定技能队列排队等待呼叫信息 https://ip:port/agentgateway/resource/calldata/{agentid}/waitcallinfo/{skillid} 质检员查询指定座席的保持列表 https://ip:port/agentgateway/resource/calldata/{agentid}/holdlistex/{workno} 座席控制:座席事件 轮询方式获取单座席事件 https://ip:port/agentgateway/resource/agentevent/{agentid}?calldata=XXX C4 座席操作类接口鉴权方式 座席双呼 创建双呼呼叫 (V1.0.0) https://域名/apiaccess/CC-Management/v1/mobileAgent/createCall C1 系统配置类接口鉴权方式 创建双呼呼叫 (V3.0.0) https://域名/apiaccess/CC-Management/v3/mobileAgent/createCall 查询呼叫历史记录 https://域名/apiaccess/CC-Management/v1/mobileAgent/queryCallDetailRecord 查询呼叫状态 https://域名/apiaccess/CC-Management/v1/mobileAgent/queryCallState 获取录音文件地址 https://域名/apiaccess/CC-Management/v1/mobileAgent/getRecordingAddress 查询分配的软电话号码 (V1.0.0) https://域名/apiaccess/CC-Management/v1/mobileAgent/queryPhone 查询分配的软电话号码 (V2.0.0) https://域名/apiaccess/CC-Management/v2/mobileAgent/queryPhone 获取呼叫目的设备信息 https://域名/apiaccess/CC-Management/v1/mobileAgent/getCalledInfo 订阅语音识别结果 订阅 https://IP:Port/agentgateway/resource/config/subscribe/register C5 智能辅助类接口鉴权方式 订阅修改 https://IP:Port/agentgateway/resource/config/subscribe/modify?serverId=xxx 取消订阅 https://IP:Port/agentgateway/resource/config/subscribe/unregister 握手 https://IP:Port/agentgateway/resource/config/subscribe/handshake/{serviceid} 握手(扩展) https://IP:Port/agentgateway/resource/config/subscribe/handshake/{serviceid} 识别结果通知 {servicecallbackuri}/v100/subscribe/asrevent/asrresult App个人设置 创建App个人设置 (create) https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/create C1 系统配置类接口鉴权方式 更新App个人设置 (update) https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/update 查询App个人设置 (query) https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/query 删除App个人设置 (delete) https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/delete 电销外呼 电销外呼 新增外呼活动 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId} C2 监控/系统外呼/话单/知识库类接口鉴权方式 修改外呼活动 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 删除外呼活动 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 查询外呼活动详情 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId} 查询外呼活动列表 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}?name={name}&status={status}&deviceType={deviceType}&beginTime={beginTime}&endTime={endTime}&curPage={curPage}&rowsPerPage={rowsPerPage} 暂停外呼活动 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId}/pause 恢复外呼活动 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId}/resume 设置外呼活动重试策略 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId} 查询外呼活动重试策略 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId} 查询外呼活动的节假日列表 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 新增外呼活动的节假日 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 修改外呼活动的节假日 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 删除外呼活动的节假日 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId}/{holidayId} 删除外呼活动的所有节假日 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 新增外呼黑名单 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/add 删除外呼黑名单 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/delete 删除所有外呼黑名单 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist 新增外呼号码 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId} 新增外呼号码(v2) https://ip:port/rest/isales/v2/openapi/campaigns/{vdnId}/calldata/{campaignId} 删除外呼号码 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete 新增号码类型 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/add 查询号码类型 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callNoType/query 查询外呼号码 /rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/{dataId} 查询租户下外呼任务列表接口 https://ip:port/rest/cmsapp/v1/openapi/fromisales/querytasks 查询指定任务的日结统计信息 https://ip:port/rest/cmsapp/v1/openapi/fromisales/dailystatistic 查询指定任务的实时统计信息 https://ip:port/rest/cmsapp/v1/openapi/fromisales/realstatistic 查询外呼结果 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId} 查询单个外呼结果详情 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId} 将外呼结果推送至指定URL。 创建外呼活动时,通过callBackUrl指定。 将业务的结果回写至外呼数据(t_isl_data)及外呼数据结果表(t_isl_data_result)中 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callBusiResult/{dataId} 机器人管理 机器人管理 领域查询接口 https://IP:PORT/oifde/rest/api/querydomaininfo C3 智能助手平台接口鉴权方式 查询对话标识绑定结果 https://IP:PORT/oifde/rest/api/querynavigationinfo 对话标识绑定新增接口 https://IP:PORT/oifde/rest/api/createnavigationinfo 对话标识绑定修改接口 https://IP:PORT/oifde/rest/api/updatenavigationinfo 对话标识绑定删除接口 https://IP:PORT/oifde/rest/api/deletenavigationinfo 流程查询接口 https://IP:PORT/oifde/rest/api/queryflows 对话接口 https://IP:PORT/oifde/rest/crs/process 交互记录查询接口 https://IP:PORT/oifde/rest/api/queryHistory 会话记录查询接口 https://IP:PORT/oifde/rest/api/queryRecordHistory 问答组查询接口 https://IP:PORT/oifde/rest/api/faqGroup/query 创建问答组接口 https://IP:PORT/oifde/rest/api/faqGroup/create 修改问答组接口 https://IP:PORT/oifde/rest/api/faqGroup/update 删除问答组接口 https://IP:PORT/oifde/rest/api/faqGroup/delete 变更问答组状态接口 https://IP:PORT/oifde/rest/api/faqGroup/changeStatus 问答查询接口 https://IP:PORT/oifde/rest/api/faq/query 创建问答接口 https://IP:PORT/oifde/rest/api/faq/create 修改问答接口 https://IP:PORT/oifde/rest/api/faq/update 删除问答接口 https://IP:PORT/oifde/rest/api/faq/delete 测试特定问答组接口 https://IP:PORT/oifde/rest/api/faq/testOneGroup 测试激活问答组接口 https://IP:PORT/oifde/rest/api/faq/testEnabledGroups 实现意图列表的查询 https://IP:PORT/oifde/rest/api/intentions/query 静默座席改变流程状态 https://IP:PORT/oifde/rest/api/flow/changeWorkMode 静默座席返回应答结果 https://IP:PORT/oifde/rest/api/flow/receiveDialogrecord 抓包录制请求结果推送接口 https://IP:PORT/oifde/rest/api/flow/asrrecognizeresult 拼写检查接口 https://IP:PORT/oifde/rest/api/spellcheck ODFS与第三方机器人系统对接的认证接口 /chatbot/serverauth/login ODFS与第三方机器人系统对接的业务请求接口 /chatbot/u-route/api/router_service/recognize 依据文本生成TTS语音接口 https://IP:PORT/oifde/rest/api/tts/texttovoice 网页客户端接入 网页客户端接入 第三方请求鉴权 https://域名/apiaccess/ccmessaging/applyToken C1 系统配置类接口鉴权方式 查询排队信息 https://域名/apiaccess/ccmessaging/queryQueueInfo 主动轮询座席侧发送给用户侧的消息。 https://域名/apiaccess/ccmessaging/poll 提交客户满意度评价结果 https://域名/apiaccess/ccmessaging/saveSatisfaction 发送消息 https://域名/apiaccess/ccmessaging/send 客户发送文件 https://域名/apiaccess/ccmessaging/uploadFileStream 客户接收文件 https://域名/apiaccess/ccmessaging/downloadFileStream 根据用户输入关键词联想推荐常用语 https://域名/apiaccess/ccmessaging/queryPhraseByKeyword 创建点击通话 https://域名/apiaccess/ccmessaging/v1/createClickToCall 获取点击通话事件 https://域名/apiaccess/ccmessaging/v1/getClickToCallEvents 检查当前租间是否支持点击通话 https://域名/apiaccess/ccmessaging/v1/checkClickToCallSupport 释放点击通话 https://域名/apiaccess/ccmessaging/v1/dropClickToCall 客户提交留言 https://域名/apiaccess/ccmessaging/doLeaveMessage 创建匿名通话 https://域名/apiaccess/ccmessaging/v1/mobileagent/createcall 提交客户对机器人满意度评价结果 https://域名/apiaccess/ccmessaging/v1/robot/feedbacksatisfaction 质检/监控/统计类接口 实时质检 插入 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/addinsert/{workNo} C4 座席操作类接口鉴权方式 侦听 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/addsupervise/{workNo} 拦截 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/intercept/{workNo} 取消侦听和插入 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/{workNo} 强制示忙 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcebusy/{workNo} 强制示闲 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forceidle/{workNo} 强制签出 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcelogout/{workNo} 强制拆除通话 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcedropcall/{callid} 调整指定座席的技能队列 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/adjustskill 切换侦听和插入 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/switch/{workNo} 强制休息 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/forcerest/{workNo}/{time}/{reason} 请求耳语 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestwhisperagent?whisperagentid={whisperagentid} 停止耳语 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requeststopwhisperagent?whisperagentid={whisperagentid} 耳语、侦听、插入切换 https://ip:port/agentgateway/resource/qualitycontrol/{agentid}/requestswitchinsertwhisperagent?whisperagentid={whisperagentid}&switchtype={switchtype} 监控/统计:实时数据查询类接口 查询指定VDN下的座席休息情况 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryagentreststate C2 监控/系统外呼/话单/知识库类接口鉴权方式 查询指定VDN下的座席电话号码 https://ip:port/rest/cmsapp/v1/openapi/vdn/allagentphones 查询指定VDN下的所有座席信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/totalagentabstractex3 查询指定VDN下的所有座席的当前状态信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/totalagentdynamicinfo 查询指定VDN下的IVR详细状态信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryivrstatusinfo 查询指定VDN下的IVR流程接入码信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryivrprocessinnoinfo 查询指定VDN下的各技能队列相关信息 https://ip:port/rest/cmsapp/v1/openapi/configures/skills 查询指定VDN所有休息原因码 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/restreasons/{ccId}/{vdn} 查询指定接入码编号的呼叫信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryaccesscodecallinfo 查询指定VDN下的呼叫信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/querycalls 查询指定VDN下的呼叫信息(v2) https://ip:port/rest/cmsapp/v2/openapi/vdn/querycalls 查询指定VDN下的通话轨迹数据 https://ip:port/rest/cmsapp/v1/openapi/vdn/querycalltracedetail 全量查询VDN下座席的静态配置信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/querytotalagentinfo 全量查询VDN下座席的当前状态 https://ip:port/rest/cmsapp/v1/openapi/vdn/totalagentstate 获取VDN维度的实时监控指标 https://ip:port/rest/cmsapp/v1/openapi/rindex/vdn 批量查询技能队列上签入的座席 https://ip:port/rest/cmsapp/v1/openapi/realindex/agent/agentsinskill 批量查询技能队列扩展信息 https://ip:port/rest/cmsapp/v1/openapi/skill/totalskillstatusex3 批量查询技能队列当前五分钟的呼叫统计信息 https://ip:port/rest/cmsapp/v1/openapi/skill/currentcallstateinfo 查询指定技能队列的状态信息 https://ip:port/rest/cmsapp/v1/openapi/realindex/skill/queuedevicestatus 批量查询技能队列的配置信息 https://ip:port/rest/cmsapp/v1/openapi/skill/skillcfginfo 批量查询技能队列的详细统计信息 https://ip:port/rest/cmsapp/v1/openapi/skill/stateinfo 批量查询技能队列上的所有排队的呼叫 https://ip:port/rest/cmsapp/v1/openapi/skill/batchmultiskill 多技能排队时,批量查询各队列接听其他队列呼叫量 https://ip:port/rest/cmsapp/v1/openapi/skill/batchskilloverload 查询技能组下各种座席状态个数 https://ip:port/rest/cmsapp/v1/openapi/realindex/skill/agentstatusbyskill 查询配置技能队列座席详细信息 https://ip:port/rest/cmsapp/v1/openapi/skill/agentbyconfigedskill 批量查询技能队列维度服务水平 https://ip:port/rest/cmsapp/v1/openapi/skill/servicequality 获取技能实时监控指标 https://ip:port/rest/cmsapp/v1/openapi/skill/rindex 批量查询座席签入的技能队列 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/siteagentcallandskillinfobyagentids 批量查询座席信息 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/agentstatusinfobyagentids 查询指定座席的当前呼叫信息 https://ip:port/rest/cmsapp/v1/openapi/agent/queryagentcalls 批量查询座席所有呼叫信息 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/queryagentcalls 查询指定座席的私有呼叫 https://ip:port/rest/cmsapp/v1/openapi/agent/agentprivatecall 查询座席组下各种座席状态个-数 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/teamagentstatusinfo 查询指定座席详细信息 https://ip:port/rest/cmsapp/v1/openapi/agent/agentbyworkno 查询座席休息信息 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/agentrestinfos 查询座席是否有通话在处理 https://ip:port/rest/cmsapp/v1/openapi/calldata/isprocesscall 查询座席维度系统状态信息 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/systemstate 获取座席实时监控指标 https://ip:port/rest/cmsapp/v1/openapi/agentgroup/rindex 获取座席操作详单 https://ip:port/rest/cmsapp/v1/openapi/agent/agentoprinfo 根据座席状态分页查询座席信息 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryAgentByStatus 查询指定callId的呼叫的基本信息 https://ip:port/rest/cmsapp/v1/openapi/calldata/querybasiccallinfo 查询指定callId的呼叫的详细呼叫信息 https://ip:port/rest/cmsapp/v1/openapi/calldata/querydetailcallinfo 根据呼叫流水号查询通话详单 https://ip:port/rest/cmsapp/v1/openapi/calldata/querycalldetailbyid 查询UAP性能信息接口 https://ip:port/rest/cmsapp/v1/openapi/uap/queryUapPerfInfo 查询终端注册状态 https://ip:port/rest/cmsapp/v1/openapi/uap/queryterminalstatus 查询控制块关键信息 https://ip:port/rest/cmsapp/v1/openapi/uap/dsppidkey 监控/统计:历史数据查询类接口 获取VDN历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/vdn C2 监控/系统外呼/话单/知识库类接口鉴权方式 获取IVR维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/ivr 获取技能维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/skill 获取座席维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agent 获取指定日期内的技能维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillforday 获取指定月份内的技能维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillformonth 获取指定日期内的坐席维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agentforday 获取指定月份内的坐席维度的历史监控指标 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agentformonth 根据查询条件查询呼入日结表的结果集。 https://ip:port/rest/cmsapp/v1/callinday/querymanualindexesbycondition 根据查询条件查询呼出日结表的结果集。 https://ip:port/rest/cmsapp/v1/calloutday/querymanualindexesbycondition 监控/统计:配置数据查询类接口 依据vdnid查询所有座席信息 https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn} C2 监控/系统外呼/话单/知识库类接口鉴权方式 依据租间ID查询所有座席信息 https://ip:port/rest/cmsapp/v1/openapi/tenant/querytenantdetail 获取VDN下的所有被叫配置 https://ip:port/rest/cmsapp/v1/openapi/configures/calledconfigs/{ccId}/{vdn} 查询接入用户可访问的所有租户信息 https://ip:port/rest/cmsapp/v1/openapi/tenant/querytenants 查询CTI平台服务器时间 https://ip:port/rest/cmsapp/v1/openapi/configures/ctiservertime 查询系统的License当前使用情况 https://ip:port/rest/cmsapp/v1/openapi/configures/querysystemlicensestatus 录音/话单类接口 录音:录音回放 开始放音 https://ip:port/agentgateway/resource/recordplay/{agentid}/play C4 座席操作类接口鉴权方式 暂停放音 https://ip:port/agentgateway/resource/recordplay/{agentid}/pauseplay 恢复放音 https://ip:port/agentgateway/resource/recordplay/{agentid}/resumeplay 放音快进 https://ip:port/agentgateway/resource/recordplay/{agentid}/forefast/{time} 放音快退 https://ip:port/agentgateway/resource/recordplay/{agentid}/backfast/{time} 停止放音 https://ip:port/agentgateway/resource/recordplay/{agentid}/stopplay 开始录屏 http(s)://ip:port/agentgateway/resource/recordplay/{agentid}/startrecordscreen 停止录屏 http(s)://ip:port/agentgateway/resource/recordplay/{agentid}/stoprecordscreen 开始录音 https://ip:port/agentgateway/resource/recordplay/{agentid}/record 停止录音 https://ip:port/agentgateway/resource/recordplay/{agentid}/stoprecord 录音:录音下载 录音下载接口 https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1 C4 座席操作类接口鉴权方式 录音下载扩展接口 https://ip:port/agentgateway/resource/recordfile/{agentid}/recordfiledownloadEx?callId= xxx&hwFileName=1 录音:视频文件下载 视频文件下载接口 https://ip:port/agentgateway/resource/recordfile/{agentid}/videofiledownload?conferenceId=xxx&recordId=xxx&fileType=xxx C4 座席操作类接口鉴权方式 视频文件下载接口(扩展) https://ip:port/agentgateway/resource/recordfile/{agentid}/videofiledownloadEx?recordId=xxx&locationId=xxx 话单下载和录音播放下载 录音下载和播放URL接口 https://ip:port/CCFS/resource/ccfs/getRecordFileUrlFromObs C2 监控/系统外呼/话单/知识库类接口鉴权方式 生成话单和录音索引 https://ip:port/CCFS/resource/ccfs/queryBillData 下载话单和录音索引 https://ip:port/CCFS/resource/ccfs/downloadBillFile 下载录音文件 https://ip:port/CCFS/resource/ccfs/downloadRecordFile 查询并下载录音文件 https://ip:port/CCFS/resource/ccfs/downloadRecord 生成座席操作详单索引 https://ip:port/CCFS/resource/ccfs/queryAgentOprInfoData 下载座席操作详单索引 https://ip:port/CCFS/resource/ccfs/downloadAgentOprInfoFile 请求回放录音文件 https://ip:port/CCFS/resource/ccfs/requestPlayVoice 回放录音文件 https://ip:port/CCFS/resource/ccfs/playVoice 下载智能IVR录音文件 https://ip:port/CCFS/resource/ccfs/downloadOiapRecord?locationId=xx 下载IVR留言录音文件。 https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId=xx 清理CC-FS和Transfer模块租户数据 https://ip:port/CCFS/resource/ccfs/deleteTenantData?vdnId=xxxx 语音通知接口 语音通知 查询语音通知的录音文件 https://域名/apiaccess/rest/voiceNotification/v1/queryVoiceNotificationRecording C1 系统配置类接口鉴权方式 创建语音通知 https://域名/apiaccess/rest/voiceNotification/v1/createVoiceNotification 创建语音通知(V2) https://域名/apiaccess/rest/voiceNotification/v2/createVoiceNotification 工单接口 工单 创建工单 https://域名/apiaccess/rest/new_case/v2/cases 工单接口 修改工单属性 https://域名/apiaccess/rest/new_case/v2/cases/modify 查询工单类型信息 https://域名/apiaccess/rest/new_case/v2/cases/casetypes 查询工单详情 https://域名/apiaccess/rest/new_case/v2/cases/casedetails 处理工单操作 https://域名/apiaccess/rest/new_case/v2/cases/dealCase 创建任务 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/create 任务接口 查询任务项信息 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskItemId 根据任务id查询任务信息 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskId 根据条件查询任务信息 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/dynamicCondition/query?mode=all 任务转派 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/transfer 任务释放 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/release 任务认领 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/claim 任务处理 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/done 任务撤回 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/recall 任务退回 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/return
  • 外呼 标示符 AgentEvent_linkagePhoneCallOut 作用 表示座席正在通过话机呼出。 附带信息 addrCalled:表示被叫号码。 addrCaller:表示座席的电话号码。 address:表示地址标识。 addressType:表示地址类型(当前只会为6,表示电话号码)。 callId:表示呼叫唯一标记(因为该callId并不是实际通话后返回的callId,所以没有用)。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneCallOut","workNo":"120","content":{"addrCalled":{"address":"70002","addressType":6},"addrCaller":{"address":"70001","addressType":6},"skillId":0,"callId":"1475051437-34"}}} 父主题: 话机联动事件
  • 接口参数说明 接口中需要传入的技能队列ID、接入码、VDNID、座席工号、班组ID、callId等参数,必须真实存在的。CC-Gateway对接口参数的校验限制在用户有效性校验,接口参数的有效性在CC-Gateway调用CTI接口时由CTI负责校验。 接口返回值和入参中时间参数如不特殊说明,默认 long 类型为时间戳格式,单位为ms。 查询类接口: 1、/resource/queuedevice/* (队列签入、排队人数等) 2、/resource/agentgroup/* (技能队列信息) 3、/resource/calldata/* (随路数据、呼叫信息等) 4、/resource/onlineagent/{agentid}/agentskills (查询配置技能队列) 5、/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} (查询指定座席配置技能队列) 6、/resource/onlineagent/{agentid}/agentstatus (获取当前座席的状态) 7、/resource/onlineagent/{agentid}/syncagentinfo (座席页面刷新时同步座席状态status和通话信息) 8、/resource/onlineagent/{agentid}/updateGuid (座席页面刷新时主动请求更新Guid) 这些接口,应用于座席综合接续应用中的转接、求助过程中,查询座席和队列的相关信息的配套查询,以及座席的当前的呼叫处理信息。为了避免多租第三方异常开发,影响系统稳定性,做了系统层级以及座席层级的流控,不可频繁的调用。 父主题: 附录
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 callSerialno string False 呼叫流水号 2 countId string False 账号 3 callId string False 呼叫ID 4 mediaAbility number False 媒体类别:1: 语音 2:视频 5 channelType number False 多媒体渠道 6 talkReason string False 会话原因ID 7 beginTime timestamp False 开始时间 8 callType number False 呼叫类型 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: {"callId": "1652317325-339","userId": "1652268429538866153","tenantId": "202205116084"} 响应参数: {"callSerialno": "1243353389979684865","countId": "1652268429538866153","callId": "1652317325-339","mediaAbility": 1,"channelType": 1,"talkReason": "1300404704098042886,1300404506395329541","beginTime": "2022-05-12 01:01:33","callType": 1}
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: {"called": "8899","voiceContent": "100001","callerPresent": "2222201","callBackUrl": "http://xx.xx.xx.xx:8800/callbackTest"} 响应参数: {"retMsg": "Created successfully.","retCode": "0", "result": {"callSerialNo": "1308434073450058757"}}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId string True 呼叫id 2 userId string True 用户id 3 tenantId string True 租户id
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 外呼被叫号码 长度限制:string(32) 2 voiceContent string True 录音id 长度限制:string(1024) 3 callBackUrl string False 回调URL 长度限制:string(256) 4 callerPresent string False 用户侧主叫外显号码 长度限制:string(32) 5 priority string False 播放语音通知优先级参数。 取值范围1-9整数,默认值为9。数字越小优先级越高。
共100000条