- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
TUC接口
- /chatbot/rest/tuc/v1/nlp/detectRegularEntity
- /chatbot/rest/tuc/v1/nlp/identify
- /chatbot/rest/tuc/v1/recommendFaq
- /chatbot/rest/tuc/v1/qualityInspection/qiOnline/recognize
- /chatbot/rest/tuc/v1/nlp/feedback
- /chatbot/rest/tuc/v1/nlp/textClassify
- /chatbot/rest/tuc/v1/nlp/detectEntity
- /chatbot/rest/tuc/v1/qualityInspection
- 内置函数
- 常见问题
- 操作员:配置普通IVR
- 配置预置流程
- IVR Journey分析
- 外呼风险监控
- 管理工单配置
- 质检管理
- 管理通知中心
- 管理客户中心
- 配置智能外呼
- 管理问卷
- 管理智能实训
- 配置知识库
- 配置公共资源
- 业务故障放通管理
- 护航浏览
- 社交媒体运营
- 绩效管理
- 客服座席指南
- 质检员指南
- 价格说明
-
开发指南
- 开发概述
- 用户接入——VOIP音视频接入
- 用户接入——网页版客户端集成 (RESTful)
- 用户接入——网页版轻量级客户端集成 (JS)
- 座席集成——座席轻量级接续块集成(JS)
- 座席集成——座席呼叫处理 (RESTful)
-
座席集成——Openeye H5 软电话接口集成
- 修订记录
- OpenEye H5软电话接口概述
- OpenEye软电话安装指导
- 座席侧集成H5软电话开发指导
- 音频呼叫接口
-
音视频呼叫接口扩展
- 音视频呼叫
-
设备管理
- getMediaDevices(获取设备列表)
- setMicIndex(设置麦克风)
- mediaGetMicIndex(查询当前使用的麦克风)
- setSpeakIndex (设置扬声器)
- mediaGetSpeakIndex (查询当前使用的扬声器)
- setMicVol(设置麦克风音量)
- getMicVol(查询麦克风当前音量)
- setSpkVol(设置扬声器音量)
- getSpkVol(查询扬声器当前音量)
- setVideoWindowParam(设置视频窗口位置和宽高)
- setVideoLayoutMode(设置视频窗口画面排列模式)
- setVideoDisplayMode(设置视频窗口画面裁剪模式)
- openCamera(打开摄像头)
- closeCamera(关闭摄像头)
- 屏幕共享
- 截屏
- 录屏
- 错误码列表
- 运营管理——座席工作台集成第三方Web页面
-
API参考
- 接口概述
- 相关术语
- 修改记录
- 接口鉴权方式
-
呼叫中心配置类
-
座席管理
- 单个创建座席业务账号(agentAccount/create)
- 单个删除指定座席业务账号(agentAccount/delete)
- 单个修改座席业务账号信息(agentAccount/update)
- 查询座席业务账号信息(agentAccount/query)
- 绑定座席和技能队列(addSkillsToAgent)
- 解绑座席某技能队列(releaseAgentBySkillId)
- 通过技能队列ID查询座席信息(queryAgentInfoBySkillId)
- 修改座席软电话号码登录密码(updateSipPhonePassword)
- 查询所有座席的软电话信息 (不包含业务账号) (querySysInfo)
- 查询所有座席的软电话信息 (包含业务账号) (queryAgentInfo)
- 查询账号登录结果 (queryAgentLoginParams)
- 根据登录账号查询座席信息 (queryAgentInfoByAccount)
- 按客户号码清理数据 (cleancustpersonaldata)
- 技能队列管理
- 号码管理
- IVR流程管理
-
座席管理
-
座席工作台
- 座席控制
-
座席双呼
- 创建双呼呼叫 (V1.0.0) (createCall)
- 创建双呼呼叫 (V3.0.0) (createCall)
- 查询呼叫历史记录 (queryCallDetailRecord)
- 查询呼叫状态 (queryCallState)
- 获取录音文件地址 (getRecordingAddress)
- 查询分配的软电话号码 (V1.0.0) (queryPhone)
- 查询分配的软电话号码 (V2.0.0) (queryPhone)
- 获取呼叫目的设备信息 (getCalledInfo)
- 创建语音外呼(V1.0.0)(createVoiceNotification)
- 创建语音外呼(V2.0.0)(createVoiceNotification)
- 查询当前会话客户的最近历史接触记录(queryUserContactLimit)
- 查询通话信息(queryCallInfoByCallId)
- ITA双呼结果通知(statusnotify)
- 回调接口
- 订阅语音识别结果接口
- App个人设置
- 附录
- 电销外呼
- 调查问卷
- 知识库管理
- 机器人管理
-
网页客户端接入
- 接口调用流程
- 第三方请求鉴权 (applyToken)
- 查询排队信息 (queryQueueInfo)
- 主动轮询座席侧发送的信息 (poll)
- 保存客户提交的满意度评价结果 (saveSatisfaction)
- 发送消息 (send)
- 客户发送文件 (uploadFileStream)
- 客户接收文件 (downloadFileStream)
- 根据客户输入联想常用语 (queryPhraseByKeyword)
- 检查当前租间是否支持点击通话 (checkClickToCallSupport)
- 创建点击通话 (createClickToCall)
- 获取点击通话事件 (getClickToCallEvents)
- 释放点击通话 (dropClickToCall)
- 创建匿名通话 (createcall)
- 客户提交留言 (doLeaveMessage)
- 提交客户对机器人满意度评价结果 (feedbacksatisfaction)
- 查询历史消息 (queryHistoryChatMessage)
- 丢弃邮件(chat_dropMail)
- 提供whatsapp发送下行消息(sendWhatsappMessage)
- 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)
- 查询满意度调查配置(getSatisfactionSurveyMode)
-
质检/监控/统计类
- 实时质检:qualitycontrol
-
智能质检
- 质检评分接口 (scoresetting)
- 句子管理接口 (sentencemanagement)
- 敏感词管理接口 (sensitiveWordManage)
- 话术接口 (conversationspecific)
- 句子、敏感词训练接口 (SemanticKeywordTraining)
- 对话逻辑接口 (conversationflow)
- 对话规则接口 (conversationrules)
- 抢插话规则接口 (interposalrules)
- 静默规则接口 (silencerule)
- 语速规则接口 (speedrule)
- 质检场景管理接口 (scenariomanage)
- 通话质检接口 (qualitycheckmanage)
- 人工抽检任务接口 (regularQualityTask)
- 质检任务接口 (qualitytask)
- 质检任务详情接口 (qualitytaskdetail)
- 质检申诉接口 (qualityitem)
- 第三方录音质检接口 (asrtrans)
-
监控/统计
-
实时数据查询类接口
-
VDN维度实时接口
- 查询指定VDN下的系统接入码信息
- 查询指定VDN下的座席休息情况
- 查询指定VDN下的座席电话号码
- 查询指定VDN下的所有座席信息
- 查询指定VDN下的所有座席的当前状态信息
- 查询指定VDN下的所有座席的静态配置信息
- 查询指定VDN下的IVR详细状态信息
- 查询指定VDN下的IVR流程接入码信息
- 查询指定VDN下的各技能队列相关信息
- 查询指定VDN所有休息原因码
- 查询指定接入码编号的呼叫信息
- 查询指定VDN下的呼叫信息
- 查询指定VDN下的呼叫信息(v2)
- 查询指定VDN下的通话轨迹数据
- 查询指定VDN下的所有座席的静态配置信息(CTI3.6版本不支持)
- 查询指定VDN下的所有座席信息(CTI3.6版本不支持)
- 获取VDN实时监控指标
- 技能队列维度实时接口
- 座席维度实时接口
- 呼叫明细维度实时接口
-
VDN维度实时接口
- 历史数据查询类接口
- 配置数据查询类接口
- 质检关系维护接口
- 外呼任务列表查询接口
- 系统指标查询接口
- 健康检查接口
- 附录
-
实时数据查询类接口
- 录音/话单类
- 语音通知
- OMA接口参考
- Case2.0接口参考
- DataProcess接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
签入
前置条件
无
接口方法
设置成“PUT”。该接口仅支持PUT方法,不支持POST、GET和DELETE等方法。
接口URI
https://ip:port/agentgateway/resource/onlineagent/{agentid}
其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号
序号 |
参数名 |
数据类型 |
选取原则 |
说明 |
---|---|---|---|---|
1 |
agentid |
string |
True |
座席的工号,取值范围:101~59999。 |
日志中的方法名
login
请求说明
- 消息头
表2 请求头参数说明 序号
名称
参数类型
是否必选
说明
1
Content-Type
string
True
消息主体编码方式,缺省值:application/json; charset=UTF-8
- 消息体
表3 消息体参数说明 序号
名称
参数类型
是否必选
说明
1
password
string
True
CTI平台的工号密码(最大长度为32)。
2
phonenum
string
True
软电话号码(最大长度为24)
3
autoanswer
boolean
False
是否自动应答,默认为true。
4
autoenteridle
boolean
False
通话结束后是否自动进入空闲态,默认为true。
5
releasephone
boolean
False
座席挂机后是否进入非长通态(呼叫结束后话机挂断):默认为true。
6
agenttype
int
False
签入的座席类型,默认为4。
- 4:pc+phone座席
- 11:pc+phone视频座席
7
status
int
False
签入后的状态,默认为空闲态。
- 3:示忙
- 4:空闲
- 5:整理态
8
ip
string
False
座席ip,默认127.0.0.1(最大长度为15),暂不支持IPV6
9
entryIp
string
False
座席客户端应用网关IP
10
phonelinkage
boolean
False
是否启动话机联动(接续和硬话机联动控制,目前仅支持 CC组网下的 espace 7910 话机)。
默认为false。
11
checkInWebm
boolean
False
是否签入Webm媒体服务器。
默认为true。
12
checkInMailm
boolean
False
是否签入Mailm媒体服务器。
默认为false。
13
vcPhoneNumber
string
False
VC号码(最大长度为24)
14
listenStatus
boolean
False
质检员是否侦听座席登录和登出的操作。
默认为false。
15
callBackUri
string
False
事件回调地址(事件回调地址)
接口定义可参考“推送事件回调接口”章节
16
serviceToken
string
False
认证码(最大长度50,不能包含特殊字符)
17
serviceworkid
string
False
业务工号(最大长度为30)。
说明:
callBackUri和serviceToken同时传入时才代表使用事件推送模式,否则依旧使用事件轮询模式。
响应说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
string |
True |
消息主体编码方式,缺省值:application/json; charset=UTF-8 |
2 |
Guid |
string |
True |
静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 |
3 |
Set-GUID |
string |
True |
值例如为“JSESSIONID=279fe2*****************0f5.AgentGateway0”其中279fe2*****************0f5.AgentGateway0为Guid |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
message |
string |
描述 |
2 |
retcode |
string |
错误码。取值如下: 0:成功 非0:失败 |
3 |
result |
Map |
查询成功后,返回结果信息的对象。 该对象的参数说明请参见表6。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
3.1 |
vdnid |
string |
虚拟呼叫中心ID。 |
3.2 |
workno |
string |
座席工号。 |
3.3 |
mediatype |
string |
签入媒体服务器是否成功,T表示成功,F表示失败,三位分别表示CTIServer、WebM、MailM。如:TTF,表示CTIServer、WebM签入成功,MailM签入失败。 只有签入CTIServer成功,才能进行语音业务处理;只有签入WebM成功,才能进行文字交谈业务处理;当前不支持签入MailM。 |
3.4 |
loginTime |
string |
签入时间,格式为时间戳。 |
3.5 |
isForceChange |
string |
是否需要强制修改密码,如果为true,则座席登录后,必须修改密码。修改密码请调用修改密码(扩展)。 如果为true,没有修改密码,该座席无法进行通话。 |
3.6 |
serverName |
string |
登录的CC-Gateway的集群名称。 |
3.7 |
timeRemaining |
string |
密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180(天)。 |
触发事件
如果签入时status参数设置3(示忙态),触发如下事件:
- 座席开始执行签入动作(AgentOther_InService)
- 示闲(AgentState_Ready)
- 示忙成功(AgentState_SetNotReady_Success)
如果签入时status参数设置4(空闲态),触发如下事件
- 座席开始执行签入动作(AgentOther_InService)
- 示闲(AgentState_Ready)
如果签入时status参数设置5(整理态),触发如下事件:
- 座席开始执行签入动作(AgentOther_InService)
- 示闲(AgentState_Ready)
- 工作中(AgentState_Work)
如果签入时开启话机联动,会额外触发如下事件:
- 联动能力事件(AgentEvent_linkageCapability)
错误结果码
- 100-001
- 100-002
- 100-003
- 100-004
- 100-007
- 100-012
- 100-015
- 100-016
- 110-016
- 999-001
报文样例
- 消息头
Content-Type:application/json; charset=UTF-8
- 请求参数
{ "password": "", "phonenum": "40038", "status": "4", "releasephone": "true", "agenttype": "4" }
- 响应参数
{ "message": "", "retcode": "0", "result": { "vdnid": 1, "workno": "291", "mediatype": "TTF", "loginTime": "1471585949806", "isForceChange": "false", "serverName": "AgentGateway", "timeRemaining": "9" } }