华为云用户手册

  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/handshake 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/saybusy?reason={reason}&prolong={prolong} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 reason int False 示忙原因码。 为空或者等于0时,表示无示忙原因码。 取值类型为整数,取值范围为200~250。座席示忙状态下再次示忙时此参数必选。 3 prolong boolean False 已示忙状态下是否重新设置示忙原因,取值true/false,默认值false。座席示忙状态下再次示忙时此参数必选。
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid 动态鉴权(AUTHMODE = 2)座席心跳接口返回header中的Guid。 3 service_token string False 自定义,最大长度为50,不能包含特殊字符,否则会返回100-001,建议1分钟动态刷新一次。 消息体 无
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/sendnoteletex 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 agentIds int True 接收便签消息座席工号。 最大可以传100个座席工号。 2 content string True 便签内容。 大小为0~1023个字节,内容可为空,支持中文内容。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "agentIds": [ 31002, 31003 ], "content": "hello"} 响应参数 { "result": null, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 autoflag boolean True 是否签入所有技能队列的标志,取值范围: true:自动签入座席所配置技能 false:签入指定的技能队列 true以外的参数值都作为false处理。 3 skillid string False 技能队列ID。 当签入方式{autoflag}为false时,skillid如果为空则不签入任何技能队列;skillid为技能队列ID字符串组,例如1;2;3,最大长度为4000。座席签入的技能队列为此skillid和所配置技能队列的交集。 4 phonelinkage int False 是否话机联动,接续和硬话机联动控制。取值范围: 1:是 0:否 目前仅支持CC组网下的espace 7910 话机。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/updateGuid 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result object 查询成功后,返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 guid string 每个配置用户登录后获得唯一的Guid标识
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1" }, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/setcustomstate?customstate={customstate} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 customstate integer True 座席自定义状态,取值范围:0~65534。 说明: 由业务侧统一定义具体含义。
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/answer?{callid=XXXX} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 callid string False 呼叫ID,在多媒体通话时会有多个callid存在,呼叫应答需要携带callid。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/querycustomstate 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "agentcustomstate": "65535" }, "message": "success", "retcode": "0" }
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/snatchpickup?destWorkNo={destWorkNo} 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTP(或HTTPS)端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 destWorkNo int True 被代答座席工号。 取值的类型为整数,取值范围为101~59999。
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/innerhelp 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 触发事件 两方求助 呼叫保持(AgentEvent_Hold) 对方振铃(AgentEvent_Customer_Alerting) 座席进入Talking(AgentEvent_Talking) 三方通话 对方振铃(AgentEvent_Customer_Alerting) 三方通话成功(AgentEvent_Conference) 内部求助失败 咨询失败(AgentEvent_Consult_Fail)
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/dropcall/{callid} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 callid string True 待拆除的呼叫callid。
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 dstaddress string True 求助对象,座席工号或技能队列ID 2 devicetype int False 求助设备类型,技能队列为1,座席为2,默认为2。 3 mode int False 求助模式,两方求助为1,三方求助为2,默认为1。 4 callappdata string False 需设置的随路数据。内容可为空,最大长度为16k。 5 holdflag boolean False 三方转时是否保持呼叫,取值为false时不保持,true为保持,默认为true
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "dstaddress": 49997, "devicetype": 2, "mode": 1, "callappdata": "", "holdflag": "true"} 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095"}
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/requestcall/{callid}/{skilltype}?skillId={skillId} 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 callid string True 排队呼叫的callid。 3 skilltype int True 技能队列类型。仅支持0:公有队列。 4 skillId int True 技能队列ID。只在公有队列时才有效。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/cancelsetcustomstate 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/seconddialex?number={number} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 number string True 二次拨号号码,取值范围:1-24位数字或*或#
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/connecthold/{callid} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 callid string True 呼叫唯一标识callid。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/logout 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI 1.https://ip:port/agentgateway/resource/voicecall/{agentid}/release 2.https://ip:port/agentgateway/resource/voicecall/{agentid} 第2个接口为了兼容老版本提供,不推荐使用该接口。 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 workno string True 待查询的座席工号,取值范围为101~59999。 该座席工号必须与前面agentid为同一vdn下面的座席。
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result array 查询成功后,返回结果信息的对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 name string 技能名称 。 3.2 id int 技能ID。 3.3 mediatype int 媒体类型。其中: 1:文字交谈 2:点击通话 4:回呼请求 5:普通音视频电话 15:预测呼出 16:预浏览呼出 17:消息呼叫 19:视频普通呼叫 51:多媒体Web Chat 53:Social Chat
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "name": "defaultMediaSkill", "id": 1, "mediatype": 53 }, { "name": "defaultAudioSkill", "id": 3, "mediatype": 5 } ], "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogout 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全