华为云用户手册

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/mediaswitch?mediaType=3&videoDirection=4 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 mediaType int True 切换的目标媒体类型，取值范围： 1：音频 3：视频 3 videoDirection int False 视频方向，取值范围： 1：用户只接收视频不发送视频 2：用户只发送视频不接收视频 3：用户既发送也接收视频 4：不设置接收发送方向 缺省值：4。 说明： 仅在mediaType配置为3时，可使用该参数。

请求说明 消息头 表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 False 呼叫callid 2 mode int True 拒接模式，1：呼叫回原队列、座席示忙；2：呼叫释放、座席空闲 拒接模式是针对普通场景（用户呼入，座席拒接）进行说明的，对于复杂场景，例如内部求助、转移等场景，需要根据具体场景来判断拒接效果。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid": "1455885056-1095", "mode": "1"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/phonepickup 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/reject 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号，{agentid}为座席工号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "agentState": 4, "isWorking": false }}

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/settalkright?flag={flag} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号，{agentid}为座席工号，{flag}为表示是否接听来话（1表示接听来话，0表示不接听来话）。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 flag int True 是否接听来话，取值范围： 1：表示接听来话 0：表示不接听来话

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentstatus 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result array 请参考表4 表4 座席状态信息 序号 名称 参数类型 说明 3.1 agentState int 座席状态。请参考表1 3.2 isWorking boolean false表示没有正在通话。 true表示正在通话。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/logininfo 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的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 phonetoken string 临时token。 3.2 phonenum string 座席签入的软电话号码。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "phonenum": "88880001", "phonetoken": "XXX" }, "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/disconnect/{number} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 number string True 待释放的电话号码，取值范围：1-24位数字。 内部求助时，座席操作挂断被求助座席{number}为座席工号，挂断座席本身{number}为该座席的软电话号码。被求助方只可主动挂断自己，不允许操作座席和用户。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentskills 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 表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 } ], "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/forcelogoutwithreason/{reason} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号，{agentid}为座席工号，{reason}为座席签出原因码（范围1-255）。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 reason int True 座席签出原因码，取值范围：1-255。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "password": "", "phonenum": "40038", "status": "4", "releasephone": "false", "agenttype": "4"} 响应参数 { "message": "", "retcode": "0", "result": { "vdnid": 1, "workno": "291", "mediatype": "TTF", "loginTime": "1471585949806", "isForceChange": "false", "serverName": "AgentGateway", "timeRemaining": "9" }}

触发事件 如果签入时status参数设置3（示忙态），触发如下事件： 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 示忙成功（AgentState_SetNotReady_Success） 如果签入时status参数设置4（空闲态），触发如下事件 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 如果签入时status参数设置5（整理态），触发如下事件： 座席开始执行签入动作（AgentOther_InService） 示闲（AgentState_Ready） 工作中（AgentState_Work）

响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。 说明： 如果为false有安全风险，请谨慎使用，建议使用true，表示下次登录必须修改密码。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。 说明： 空字符串有安全风险，请谨慎使用，建议设置取值范围内的值，保证定期修改密码。

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/loginex 其中，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 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 password string True 座席密码（最大长度为32，可为空）。 2 phonenum string False 座席电话（最大长度为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 是否启动话机联动（接续和硬话机联动控制）。 默认为false。 11 checkInWebm boolean False 是否签入Webm媒体服务器。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/phonehangup 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/beginmute 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 操作结果。0：成功，非0为失败 1.2 description string False 提示信息 1.3 restTime string False 休息时长，单位秒 1.4 agentType string False 座席类型（4：音频座席，5：多媒体座席，11：视频座席，99：全能型座席） 1.5 forceLogin boolean False 是否强制签入（true：是，false：否） 1.6 isAutoAnswer string False 是否自动应答（true：是，false：否） 1.7 videoMode number False 视频应用模式（0：SFU视频，1：MCU视频，2：SFU+MCU视频） 1.8 workNo number False 座席工号 1.9 isMultiChannelSupport boolean False 是否多渠道签入（true：是，false：否） 1.10 skills array[object] False 技能队列列表 1.10.1 skillId number False 技能队列ID 1.10.2 mediaTypeId string False 媒体类型（5：语音；53：多媒体；19：视频；2：语音点击通话；18：视频点击通话） 响应状态码: 401 鉴权失败 响应状态码: 404 请求资源不存在 响应状态码: 500 服务器内部异常

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phone string True 进行接听的号码（真实可用的号码，比如手机号、座机号） 1.2 workNo number True 座席工号

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:*********************Authorization:Bearer ********************* 请求参数: {"phone":"13800000000","workNo":107} 响应参数: { "restTime": "", "agentType": "4", "forceLogin": true, "isAutoAnswer": "true", "description": "success", "videoMode": 0, "workNo": 107, "skills": [ { "skillId": 4, "mediaTypeId": "5" } ], "returnCode": "0", "isMultiChannelSupport": false}

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/thirdPartyConfTransmitNum 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权信息，值为Bearer + tokenByAKSK接口的返回值中的AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 workNo number True 座席工号

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "callfeature": 0, "callid": "1476838963-224", "caller": "70004", "called": "60015", "callskill": "voice", "callskillid": 20011, "orgicallednum": "", "calldata": "", "begintime": 1476838963000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": { "waitBeginTime": 1626179227000, "waitEndTime": 1626179227000, "answerBeginTime": 1626179227000, "answerEndTime": 1626179227000, "talkBeginTime": 1626179227000, "talkEndTime": 1626179227000, "deviceNo": 2005, "deviceType": 2, "callDirectMode": "NORMAL_DIRECT", "enterReason": 0, "enterReasonDesc": "Normal reason", "leaveReason": 0, "leaveReasonDesc": "Normal reason", "vdnId": 214 } }}