华为云用户手册

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False App标识 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 password string(100) True 登录密码 1.2 account string(100) True 登录账号

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 message string(1024) False 账号校验信息 1.2 returnCode string(10) False 账号校验返回码 0：成功 1：失败 1.3 results object False 查询结果 表4 Results参数结构 序号 名称 参数类型 是否必选 说明 1.1 workNo string(5) False 座席工号 1.2 password string(100) False 座席签入登录平台的加密前密码 1.3 sipAccount string(24) False SIP软电话号码 1.4 sipPwd string(100) False SIP软电话加密前密码 1.5 sipServerInfo array[SIPServerInfo] False SIP服务信息 表5 SIPServerInfo参数结构 序号 名称 参数类型 是否必选 说明 1.1 sipServiceIp string(50) False 软电话注册地址 1.2 sipServicePort string(5) False 座席登录服务端口 1.3 node string(10) False sip服务节点 1.4 type string(10) False sip服务类型，默认SIP 0：SIP 1：WebRTC 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

响应说明 表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 } ]}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "mediatypeId": 5, "description": "接入码", "limit":10, "offset":0} 响应参数: { "returnCode": "0", "data": { "total": 1, "calledRouteList": [ { "id": "1124167935465633793", "accessCode": "9911411", "mediatypeId": 5, "n400Number": null, "description": null, "numCallAttr": 3 } ] }, "description": "success"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 data object False - 1.1.1 total number False 数据总量 1.1.2 calledRouteList array[object] False 接入码信息列表 1.1.2.1 id string False 接入码ID 1.1.2.2 accessCode string False 接入码 1.1.2.3 mediatypeId integer False 媒体类型： 2：语音点击通话 5：音视频 18：视频点击通话 19：视频 53：多媒体 1.1.2.4 n400Number string False 接入码页面配置的服务号码，通常为核心网映射的400号码 1.1.2.5 description string False 接入码描述 1.1.2.6 numCallAttr number False 号码属性（3：呼入和呼出；2：呼出；1：呼入） 1.2 returnCode string False 返回码 0：成功 其他：失败 1.3 description string False 描述 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string False 接入码 支持模糊查询 1.2 mediatypeId integer False 媒体类型 2：点击通话 5：音视频 53：多媒体 1.3 description string False 接入码描述 支持模糊查询 1.4 limit integer False 表示每页的查询数量，0-100，默认100，如果输入超过100，将默认查询100条 1.5 offset integer False offset用于确定查询的起始页。offset取值范围为：offset=limit*(page-1)，page为需要查询的起始页。offset默认值0，最大值100

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "limit": "10", "offset": 0} 响应参数: { "returnCode": "0", "total": 1, "data": [ { "skillId": 1, "maxAgentWrapupTime": 5, "maxWaitTime": 60, "name": "defaultVideoSkill", "mediaTypeId": 19, "description": "2021ok", "maxWaitNum": 100, "skillParam": { "noAgents": { "transferType": "Release" }, "busy": { "transferType": "Release" }, "answerFunction": "0", "timeOut": { "transferType": "Release" }, "waitVoice": { "parameterType": "Voice" } } } ], "description": "success"}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "accessCode": "9911411", "extCode": "11", "devicetype": 1, "deviceId": 1, "mediaTypeId": 19} 响应参数: { "returnCode": "0", "description": "data create success"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0：成功 其他：失败 1.2 description string False 描述 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accessCode string True 接入码；最大长度32字符 1.2 extCode string False 扩展码； 最大长度12字符（如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现，例如，接入码为12345，我们可以添加扩展码1，路由到技能队列A，扩展码2，路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。） 1.3 mediaTypeId integer False 媒体类型；默认值：5 字段可选值：（2：语音点击通话 5：音视频 18：视频点击通话 19：视频 53：多媒体） 说明： 1、传入技能队列（devicetype=1）时，mediaTypeId等于传入的技能队列绑定的mediaTypeId（没有绑定默认5） 2、接入码accessCode所属的媒体类型（查询接入码接口返回的mediaTypeId字段）和该入参mediaTypeId的对应关系如下： 5对应5和19； 53对应53； 2对应2和18 1.4 devicetype integer True 设备类型； 1：技能队列 3：IVR 说明：多媒体渠道不能选择IVR流程 1.5 deviceId integer True 目标设备id（技能队列skillId、IVR的id） 说明：传入技能队列（devicetype=1）时，deviceId的对应的媒体类型要和入参mediaTypeId一致

响应说明 表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 当前状态原因码

接口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/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "dnids": "1,2"} 响应参数: { "returnCode": "0", "data": { "name": "9911411,99114111", "id": "1127983948544239618,1127986019188238339", "content": "9911411,99114111" }, "description": "data delete success"}

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

请求说明 消息头 表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。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 dnids string True 配置编号(查询被叫时返回的dnid); 删除多个用，隔开；最大删除数1000

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0：成功 其他：失败 1.2 description string False 描述 1.3 data object False 删除情况展示 1.3.1 id string False 删除的绑定数据id 1.3.2 name string False 删除的绑定数据"accessCode"+"extCode" 1.3.3 content string False 删除的accessCode 1、全部删除成功或者全部删除失败时，和name一样 2、部分删除成功时，字符串结构为"Success:"+"同name一样"+"，Failed:"+"同name一样" 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

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

接口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：第三方最大化

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

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