华为云用户手册

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

接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/adjustvideomode 其中，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 mode Interger True mode展现模式，取值范围：0-3，0：通话三方画面等大，1：用户最大化，2：座席最大化，3：第三方最大化

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

接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/waitnumbyagent 其中，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 3.4 serviceType int 业务类型编号 3.5 realFlag int 1表示实队列。0表示虚队列。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "name": "voice", "id": 1, "mediatype": 5, "serviceType": 1, "realFlag": 1 }, { "name": "callback", "id": 2, "mediatype": 4, "serviceType": 1, "realFlag": 1 }, { "name": "webchat", "id": 3, "mediatype": 1, "serviceType": 1, "realFlag": 1 }, { "name": "email", "id": 4, "mediatype": 6, "serviceType": 3, "realFlag": 1 } ]}

呼叫数据:calldata 本节下所列接口应用场景为： 在座席转接、求助过程中，查询座席和队列的相关信息，以及座席的当前的呼叫处理统计信息。 为了确保系统稳定性，该类接口在系统层级以及座席层级做了过负荷控制： 系统最大允许查询请求个数，默认为15000次/2秒 单个座席允许的查询请求消息数为，默认为5次/2秒 因此使用此类接口时请考虑过负荷机制，请勿短时间频繁调用接口导致系统崩溃。 查询呼叫信息 查询呼叫随路数据 设置呼叫随路数据（扩展） 查询保持列表 查询应答来话前呼叫信息 根据呼叫CallID查询呼叫信息 查询指定座席呼叫ID 查询座席当前的话路数 查询座席当前呼叫统计信息 查询座席当前呼叫统计信息（扩展） 查询指定技能队列排队等待呼叫信息 质检员查询指定座席的保持列表 父主题： 座席控制

接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/ivrinfo 其中，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 int 查询成功时，返回排队总人数 查询失败时，不返回该项 该对象的参数说明请参见表4 表4 result参数说明 序号 名称 参数类型 说明 3.1 access string 流程接入码。 3.2 id int IVR流程ID。 3.3 description string IVR流程描述。 3.4 serviceNo int 服务ID。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "access": "1321", "id": 1, "description": "252", "serviceNo": 1 } ], "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 skills List True 技能队列ID列表，数组长度不能大于100

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "skills": [ 1, 10 ]} 响应参数 { "message": "", "retcode": "0", "result": [ { "pilotNbr": "", "deviceNo": 1, "queueSize": 0, "queueTime": 0, "loadFactor": 65535, "estWaitTime": 0, "loggedOnAgents": 1, "availAgents": 1, "transferFlg": 0, "transferDeviceType": 255, "transferDeviceNo": 65535, "skillDescrip": "chat_madeqiang", "resourceIdleRate": 100, "serviceLevel": 100, "oldCallIdEx": { "dateTime": 4294967295000, "dsn": 65535, "server": 255, "handle": 255 }, "maxQueueSize": 100 }, { "pilotNbr": "1009", "deviceNo": 10, "queueSize": 0, "queueTime": 0, "loadFactor": 65535, "estWaitTime": 0, "loggedOnAgents": 2, "availAgents": 2, "transferFlg": 0, "transferDeviceType": 255, "transferDeviceNo": 65535, "skillDescrip": "chat_jinsitao", "resourceIdleRate": 100, "serviceLevel": 100, "oldCallIdEx": { "dateTime": 4294967295000, "dsn": 65535, "server": 255, "handle": 255 }, "maxQueueSize": 100 } ]}

接口URI https://ip:port/agentgateway/resource/queuedevice/{agentid}/queryacdstat 其中，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 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "workno": "20011", "name": "20011", "status": "4", "ctiStatus": "1", "groupid": 1, "groupname": null, "skilllist": [], "mediatype": "TTT", "vdnid": 6, "phonenumber": "70942", "currentstatetime": 1376, "logindate": 1501125758000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ]}

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回座席对象列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 workno string 座席工号 3.2 name string 座席名称 3.3 status int 座席状态，参见表1 3.4 ctiStatus int 座席平台状态，请参考表2 3.5 groupid int 座席班组ID 3.6 groupname string 未使用该返回参数 3.7 skilllist list 未使用该返回参数 3.8 callids list 未使用该返回参数 3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.10 vdnid int 所属VDN ID 3.11 phonenumber string 座席电话号码 3.12 currentstatetime long 当前状态时长（秒） 3.13 logindate long 签入时间，时间戳（毫秒） 3.14 inMultimediaConf int 未使用该返回参数 3.15 currentStateReason int 当前状态原因码

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回座席对象列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 workno string 座席工号 3.2 name string 座席名称 3.3 status int 座席状态，参见表1 3.4 ctiStatus int 座席平台状态，请参考表2 3.5 groupid int 座席班组ID 3.6 groupname string 未使用该返回参数 3.7 skilllist list 座席技能对象列表 该对象的参数说明请参见表5。 3.8 callids list 未使用该返回参数 3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.10 vdnid int 所属VDN ID 3.11 phonenumber string 座席电话号码 3.12 currentstatetime long 当前状态时长（秒） 3.13 logindate long 签入时间，时间戳（毫秒） 3.14 inMultimediaConf int 是否在多媒体会议中。 0表示不在多媒体会议中。 1表示在多媒体会议中。 3.15 currentStateReason int 当前状态原因码

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "workno": "20011", "name": "20011", "status": "4", "ctiStatus": "1", "groupid": 1, "groupname": "jst", "skilllist": [ { "name": "clicktodial_jst", "id": 10, "mediatype": 2 }, { "name": "callback", "id": 2, "mediatype": 4 }, { "name": "webchat", "id": 3, "mediatype": 1 }, { "name": "email", "id": 4, "mediatype": 6 }, { "name": "voice_hym", "id": 5, "mediatype": 5 }, { "name": "voice", "id": 6, "mediatype": 5 }, { "name": "webchat_jst", "id": 9, "mediatype": 1 } ], "mediatype": "TTT", "vdnid": 6, "phonenumber": "70942", "currentstatetime": 1210, "logindate": 1501125758000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 }}

接口URI https://ip:port/agentgateway/resource/agentgroup/{agentid}/agentbyworkno/{workno} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 workno string True 待查询的座席工号，取值范围：101～59999。 该座席工号必须与前面agentid为同一vdn下面的座席。

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "skillId": 1, "agent": [ { "workno": "2005", "name": "liukai011", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TFF", "vdnid": 214, "phonenumber": "88880026", "currentstatetime": 527, "logindate": 1616510142000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 }, { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 5 }, { "skillId": 2, "agent": [ { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 53 } ], "message": "success", "retcode": "0"}

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回结果列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 skillMediaType int 技能队列媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.2 skillId int 技能队列id 3.3 agent list 座席详细信息 该对象的参数说明请参见表5。 表5 agent对象参数说明 序号 名称 参数类型 说明 3.3.1 workno string 座席工号 3.3.2 name string 座席名称 3.3.3 status int 座席状态，参见表1 3.34 ctiStatus int 座席平台状态，请参考表2 3.3.5 groupid int 座席班组ID 3.3.6 groupname string 未使用该返回参数 3.3.7 skilllist list 未使用该返回参数 3.3.8 callids list 未使用该返回参数 3.3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.3.10 vdnid int 所属VDN ID 3.3.11 phonenumber string 座席电话号码 3.3.12 currentstatetime long 当前状态时长（秒） 3.3.13 logindate long 签入时间，时间戳（毫秒） 3.3.14 inMultimediaConf int 未使用该返回参数 3.3.15 currentStateReason int 当前状态原因码

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/setcalldataex 其中，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 False 呼叫ID。 2 calldata string False 随路数据。原始内容最大长度支持16K字节。 说明： 该信息采用AES128-CBC加密存储，采用TLS1.2加密通道传输。 该字段为敏感数据，日志中只使用calldatalength表示该字段长度。 3 isDataEncoded boolean False 呼叫数据是否经过base64编码，取值如下： true：calldata必须是经过base64编码后的字符。 false：calldata未经过base64编码。 默认值为false。 说明： Base64是一种编码方式，不是加密算法，不能用作任何敏感信息的加密用途。

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

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result object 查询成功后，返回呼叫保持列表对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考表1 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述 3.6 callskillid int 未使用该返回参数 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 未使用该返回参数 3.9 begintime long 未使用该返回参数 3.10 endtime long 未使用该返回参数

报文样例 消息头 Content-Type:application/json; charset=UTF-8Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "callfeature": 7, "callid": "1501127996-2", "caller": "10086", "called": "70943", "callskill": "voice", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null }, { "callfeature": 7, "callid": "1501127920-0", "caller": "10086", "called": "70941", "callskill": "", "callskillid": 0, "orgicallednum": "", "calldata": null, "begintime": null, "endtime": null } ]}

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/holdlist 其中，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 请求参数 无 响应参数 { "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 } }}