华为云用户手册

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/beginmute 其中，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 called string True 被叫号码。called必须包含在预览事件的dialeddigits字段中，不在此字段中的号码，不能呼叫。 2 callcontrolid long True 预呼控制块号。callcontrolid是预览外呼事件中的controllid。

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/previewCallout 其中，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 请求参数 { "called": "88889039", "callcontrolid": "11776"} 响应参数 { "message": "", "retcode": "0", "result": "1455885056-1095"}

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/endmute 其中，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 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

接口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）

报文样例 消息头 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"}

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": { "callinfo": null, "agentStateInfo": { "callFeature": 0, "callData": "", "lastState": 255, "preBusy": false, "firsttalkingFlag": false, "workNo": "41001", "qcWorkNo": "", "callerNo": "", "beginHoldTime": null, "state": 1, "talkingCallfeature": 0, "releaseFlag": 0, "calledNo": "", "mainCallId": "", "secondTalkingTime": null, "preRest": false, "recordID": "", "currentTime": "1566636307992", "beginTalkingTime": null, "partner": "", "holdCallId": "", "agentStateBeginTime": 1566636286408, "curCommand": 0, "curCallId": "", "cmdBeginTime": "" } }, "message": "success", "retcode": "0"}

接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/syncagentinfo 其中，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 callinfo string 通话信息。 3.2 agentStateInfo object 座席状态信息，该对象的参数说明请参见表5。 表5 agentStateInfo对象参数说明 序号 名称 参数类型 说明 3.2.1 callFeature int 呼叫原始类型。特征ID，详细见表6。 3.2.2 callData string 呼叫相关信息。 3.2.3 lastState int 座席最后的状态。 3.2.4 preBusy boolean 是否示忙。 3.2.5 firsttalkingFlag boolean 是否第一次通话。 3.2.6 workNo string 座席工号。 3.2.7 qcWorkNo string qc座席工号。 3.2.8 callerNo string 主叫号码。 3.2.9 beginHoldTime string 开始保持时间，时间戳，单位：ms。 3.2.10 state int 座席状态。 详细状态码和含义请参见表3。 3.2.11 talkingCallfeature int 通话呼叫原始类型，详细见表6。 3.2.12 releaseFlag int 会话是否释放。 暂未使用。 3.2.13 calledNo string 被叫号码。 3.2.14 mainCallId string 首次发起呼叫的callid。 3.2.15 secondTalkingTime string 第二次通话时间，时间戳，单位：ms。 3.2.16 preRest boolean 是否休息。 3.2.17 recordID string 录音流水号。 3.2.18 currentTime string 当前时间，时间戳，单位：ms。 3.2.19 beginTalkingTime string 开始通话时间，时间戳，单位：ms。 3.2.20 partner string 合作伙伴。 3.2.21 holdCallId string 保持的呼叫callid 3.2.22 agentStateBeginTime string 座席状态开始时间，时间戳，单位：ms。 3.2.23 curCommand int 当前命令，详细含义见表7。 3.2.24 curCallId string 当前的呼叫callid。 3.2.25 cmdBeginTime string 命令开始时间，时间戳，单位：ms。 表6 呼叫类型信息 状态值 说明 -1 其他。 0 普通呼入。 6 内部呼叫。 7 普通呼叫。 41 HPS预占式外呼。 44 HPS预测式外呼。 45 HPS预约回呼。 51 内部两方咨询。 52 内部三方咨询。 53 多方通话 表7 操作命令信息 状态值 说明 0 无命令。 1 座席挂机。 2 座席断开连接。 3 用户挂机。 4 首次外呼。 5 外呼。 6 保持。 7 取消保持。 8 静音。 9 取消静音。 10 释放转。 11 成功转。 12 通话转。 13 三方转。 14 挂起转。 15 特殊转。 16 两方求助。 17 三方求助。 18 三方通话。 19 放音。 20 插入。 21 侦听。 22 切换。 23 拦截。 24 耳语。 30 示忙。 31 休息。

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 called string True 被叫座席的座席工号。内容不可为空，1-24位数字或*或# 2 caller string False 主叫号码。内容可为空，为空时为平台默认主叫号码，0-24位数字 3 skillid int False 技能ID。数字类型，内容可为空，为空时为平台配置默认的技能队列ID。 4 callappdata string False 随路数据信息。可为空，最大长度为16k。 5 mediaability int False 内部呼叫时，该值设置无效。内部呼叫以座席签入的媒体类型和VDN默认技能队列媒体能力的交集能力拉起呼叫。如果座席签入的视频媒体能力，VDN默认技能队列也支持视频服务，则内部呼叫拉起的是视频媒体能力呼叫。其他情况内部呼叫拉起的都是音频媒体能力呼叫。

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

触发事件 物理话机振铃（AgentOther_PhoneAlerting） 物理话机摘机（AgentOther_PhoneOffhook） 通话中（AgentState_Busy） 对方振铃（AgentEvent_Customer_Alerting） 座席进入Talking（AgentEvent_Talking） 内部呼叫失败（AgentEvent_Inside_Call_Fail） 外呼失败（AgentEvent_Call_Out_Fail） 连接失败（AgentEvent_Connect_Fail）

接口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/voicecall/{agentid}/gethold?callid={callid} 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 callid string False 呼叫唯一标识callid。

接口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}/canceltransfer 其中，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 请求参数 { "devicetype": 2, "mode": 3, "address": "49998", "callappdata": "", "caller": "40040", "mediaability": 0, "holdflag": "true"} 响应参数 { "result": {}, "message": "success", "retcode": "0"}

触发事件 座席进入（AgentEvent_Talking） 连接失败（AgentEvent_Connect_Fail） 座席挂断呼叫（AgentEvent_Call_Release） 转移模式为成功转时： 成功转结果通知（AgentEvent_SuccTransResult） 停止录音成功（AgentMediaEvent_StopRecordDone） 转移模式为三方转时： 三方通话成功（AgentEvent_Conference） 转移模式为挂起转 从IVR返回（AgentEvent_ReturnFromIvr）

接口URI https://ip:port/agentgateway/resource/voicecall/{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 devicetype int True 转移设备类型，技能队列为1，业务代表为2，IVR设备为3，系统接入码为4，外呼号码为5。 2 address string True 转移地址，最大长度24。取值范围： 当devicetype为1时，配置技能队列的编号ID。 当devicetype为2时，配置待转移座席的座席工号。 当devicetype为3时，配置IVR流程接入码。 当devicetype为4时，配置系统接入码。 当devicetype为5时，配置外呼号码。 3 mode int True 转移模式。 当devicetype值为1时取值： 0：释放转 2：成功转 当devicetype值为2时取值： 0：释放转 2：成功转 当devicetype值为3时取值： 0：释放转 1：挂起转 说明： 挂起转可以转音视频IVR流程，不能转座席。 当devicetype值为4时取值： 0：释放转 2：成功转 当devicetype值为5时取值： 1：释放转（呼出时不支持向指定外呼号码释放转） 2：成功转 3：通话转 4：三方转 4 callappdata string False 需设置的随路数据。内容可为空，最大长度为16k。 5 caller string False 主叫号码。（内容可为空，为空时为平台默认主叫号码，0-24位数字）。在转外部号码时有效。并且当转出方式为“释放转”时，该参数值无效，即不能携带指定的主叫号码。 6 mediaability int False 媒体能力。（默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。在转外部号码时有效，其他方式的转移根据座席的类型来判断是否带媒体能力） 7 holdflag boolean False 三方转时是否保持呼叫，取值为false时不保持，true为保持，默认为true 8 skillId Integer 可选 技能ID。当devicetype为业务代表为2时，设置该字段才有效。

接口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。

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/confjoin 其中，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 已经保持住的呼叫的callid。不可为空 2 callappdata string False 需设置的随路数据。内容可为空，最大长度为16k。

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

接口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/voicecall/{agentid}/mediaswitch?mediaType=3 其中，ip为CC-Gateway服务器地址，port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 mediaType int False 切换的目标媒体类型，取值范围： 1：音频 3：视频

接口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}为该座席的软电话号码。被求助方只可主动挂断自己，不允许操作座席和用户。