华为云用户手册

  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "talktime": 4328, "answernums": 5, "calloutnums": 0 }}
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 mediaType string True 媒体类型。其中: 1:文字交谈 2:点击通话 4:回呼请求 5:普通音视频电话 15:预测呼出 16:预浏览呼出 17:消息呼叫 19:视频普通呼叫 51:多媒体Web Chat 53:Social Chat 2 callnums string True 座席最大会话数,最大值:60,最小值:1。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "mediaType": "53", "callnums": "1"} 响应参数 { "message": "success", "retcode": "0"}
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid": "1552524689-16797284", "caller": "88880021", "devicetype": 2, "mode": 2, "address": "205", "calldata": "help"} 响应参数 { "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/setcallnums 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/transfer 其中,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 callid string True 呼叫标识。 2 caller string False 主叫号码。 3 devicetype int True 转出的设备类型。 1:技能队列 2:座席 4:系统接入码 4 mode int True 转出的模式,详细释义见表4。 当devicetype值为1时取值: 0:释放转 2:成功转 当devicetype值为2时取值: 0:释放转。 2:成功转。 当devicetype值为4时取值: 0:释放转。 2:成功转。 5 address string True 转移地址,即转移设备类型对应的设备ID。最大长度24。 当devicetype为1时,此处为技能队列编号;当devicetype为2时,此处为座席平台工号;当devicetype为4时,此处为系统接入码。 6 calldata string False 携带数据给转接的座席,最大不能超过2048个字节。 7 skillId Integer 可选 技能ID。当devicetype为业务代表为2时,设置该字段才有效。
  • 座席会议:agentconf 座席会议只支持音频会议,不支持视频会议。 申请座席会议 座席应答会议 座席拒接会议 退出座席会议 释放座席会议 保持与会者 取保持与会者 主席申请延长会议时间 转移主席权限 批量邀请与会者 批量删除与会者 修改与会者属性 座席会议放音 停止座席会议放音 座席会议通道放音 停止座席会议通道放音 改变会议资源方数 批量查询会议信息 查询VDN中正在进行的会议ID 父主题: 座席控制
  • 接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/getconnectinfo 其中,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 userType string True 用户类型。 默认为“agent”代表座席 2 callid string True 呼叫标识。
  • 响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 retcode string 消息发送结果。 0:成功 非0:失败 2 message string 描述 3 result object 查询成功后,返回连接信息对象。 该对象的参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 1 userId string 坐席工号 2 ctime string 过期时间 3 channelId string 频道ID(房间ID) 4 role string 角色 5 ip string 媒体服务器接入点IP地址 6 port string 媒体服务器接入点端口 7 signalingDomainIn string 内侧信令domain; 格式:https://域名:端口 8 signalingDomainOut string 外侧信令domain; 格式:https://域名:端口 9 locationId string 节点 10 signature string 签名 11 appId string 用户标识
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 {"callid":"1552524689-16797284","userType":"agent"} 响应参数 {"message": "success","retcode": "0","result":{ "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" }}
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 {"callid":"1552524689-16797284","userType":"user"} 响应参数 { "message": "success", "retcode": "0"}
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 userType string True 用户类型。 默认为“user”代表用户 2 callid string True 呼叫标识。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/answeragentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/imagecapture 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/rejectagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "memberNum": 4, "confCallerNo": "10000", "time": 50, "promptTime": 5, "beepTone": true, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 触发事件 通话中(AgentState_Busy) 物理话机振铃(AgentOther_PhoneAlerting) 物理话机摘机(AgentOther_PhoneOffhook) 自己加入会议(AgentConf_SelfJoinResult) 会议申请成功(AgentConf_RequestSuccess) 会议申请失败(AgentConf_RequestFailed) 会议结束前提示时长:会议超时提醒事件(AgentConf_Timeout)
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/requestagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 场景描述 座席调用该接口申请一个座席会议,调用成功后则需要等待后续的异步事件,申请成功后,申请会议的座席会成为会议主席。申请会议的座席接收到AgentConf_SelfJoinResult事件,表明申请会议的座席自身已加入到会议中,但还需要继续等待AgentConf_RequestSuccess事件后,座席才能进行会议主席相关的操作。在收到AgentConf_RequestSuccess事件前,座席调用会议相关的接口操作时,平台会直接返回失败。 当前座席处于空闲或者通话状态,处于通话状态时当前呼叫必须处于一个稳定状态,否则申请座席会议会失败,例如:在通话过程中进行放音、静音、保持呼叫、挂起转,则申请座席会议会返回失败。 三方通话过程中如果存在两个座席,被叫座席不允许发起座席会议。 与会者类型仅支持座席工号或电话号码。 电话会议方数小于等于vdn中设置的“并发语音最大呼叫数”。
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 memberNum int True 会场能够容纳的与会人数。 取值范围:1~120。 2 confCallerNo String False 会议外呼用户时显示的主叫号码。 最大长度为24字节。 不输入参数时,平台默认使用VDN配置台基本信息的系统主叫号码。在VDN有号码限制的情况,需要号码在限制范围内。 3 time int False 会议申请时长。 单位:分钟。 取值范围:4~1440。 默认值为60。 4 promptTime int False 会议结束前提示时长。 可选参数。 单位:分钟。 取值范围:3~1440。 默认值为3。 如果大于等于会议申请时长,按照申请时长-1计算。 5 beepTone boolean False 有用户加入、退出会议时是否播放提示音。 默认值为false。 6 playMode int False 2:播放指定文件音,默认值为2。 7 voicePath String False 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名,例如: y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时,此参数必须设置并且playMode需要为2;当“BeepTone”设置为“false”时,此参数设置无效。 最大长度为127。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/requestleaveagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "address": "88887946", "addressType": "6", "playMode": 2, "voicePath": "y:/conf/120/1136287.V3"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addressType String True 地址类型。 6:电话号码 9:座席工号 2 address String True 地址标识。 最大长度为24字节。 3 playMode int False 放音模式。 2:播放指定文件音。 默认值为2。 4 voicePath String True 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名,例如: y:/conf/120/1136287.V3 最大长度为127个字符。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/holdparticipant 其中,ip为agentgateway服务器地址,port为agentgateway服务器的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 destAgentNo int True 待转移的目标座席工号。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "destAgentNo": 2001} 响应参数 { "result": {}, "message": "success", "retcode": "0"}
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/releaseagentconf 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/applytoshiftpresident 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
共100000条