华为云用户手册

报文样例 请求头: Content-Type:application/jsonX-APP-KEY:XXXXXXXXXXXXXXXXXXXXXXXAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "skillId": 3, "description": "2021ok", "maxWaitTime": 60} 响应参数: { "returnCode": "0", "description": "Update Skill successfully"}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 响应参数: { "result": [ { "isLoad": 1, "accessCode": "90500", "maxCallNum": null, "description": "异常处理", "id": 1, "flowFileName": "defaultIVR.GSL", "flowType": 1 }, { "isLoad": 1, "accessCode": "90501", "maxCallNum": null, "description": "1015", "id": 2, "flowFileName": "defaultIVR.GSL", "flowType": 1 } ], "retCode": "0", "message": "success"}

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 result array[object] False IVR信息 1.1.1 isLoad number False 流程是否加载 0：否 1：是 1.1.2 accessCode string False 流程接入码 1.1.3 maxCallNum integer False 流程最大并发呼叫数 1.1.4 description string False 流程描述 1.1.5 id number False 流程编号 1.1.6 flowFileName string False 流程文件名 1.1.7 flowType number False 流程类型 0：未明确的业务类型 1：GSL业务文件类型 2：VoiceXML业务文件类型 3：第三方IVR的业务类型 4：CCIVR支持的VXML流程 5：CCXMLL流程 6：WaitScript流程 1.2 retCode string False 返回码 0：成功 其他：失败 1.3 message string False 返回信息 响应状态码: 400 错误的请求：请检查请求路径及参数 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: X-APP-KEY: ****************************Authorization: Bearer ******************************* 响应参数: { "returnCode": "0", "data": [ { "accessCode": "6001", "channelType": "audio", "feedbackType": "IVR", "ivrId": "1239554736420597767" } ], "description": "success", "enabled": true}

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 returnCode string True 返回码，0成功，非0失败 1.2 description string False 返回描述 1.3 enabled boolean True 是否开启满意度调查。true：已开启，false：未开启。未开启时data为空。 1.4 data array[object] False 目前只返回一个数据。 1.4.1 ivrId string False IVR流程ID 1.4.2 feedbackType string False IVR：表示是IVR类型的流程，目前只有一个值。 1.4.3 channelType string False audio：音频 media：多媒体 目前取值只有audio 1.4.4 accessCode string False 流程接入码 响应状态码: 401 授权失败：1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。

报文样例 请求头: {"x-app-key": "f******************************f""Authorization": "Bearer 0******************************8"} {"connection": "keep-alive""content-type": "application/json;charset=UTF-8"} 响应头: 响应参数: { "sipServiceIp": "10.10.96.98", "sipServicePort": 5060, "agents": [ { "workNo": 1522, "accountCode": "aaaa", "sipAccount": "88881619", "sipPwd": "***" }, { "workNo": 1523, "sipAccount": "88881620", "sipPwd": "***" } ]}

报文样例 请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "id": "1125397061153369092", "devicetype": 1, "deviceId": 1} 响应参数: { "returnCode": "0", "description": "data update success"}

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

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sipServicePort string False 软电话注册端口，1~65535 长度限制:string(5) 1.2 sipServiceIp string False 软电话注册地址，IPV4格式 长度限制:string(50) 1.3 agents array[object] False 座席集合 1.3.1 workNo integer True 座席工号，范围从101到59999 1.3.2 sipAccount string False SIP软电话号码 长度限制:string(24) 1.3.3 sipPwd string False SIP软电话加密前密码 长度限制:string(24) 1.3.4 accountCode string False 关联的Service Cloud登录账号 长度限制:string(100) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 被叫ID 1.2 devicetype integer True 设备类型；1：技能队列 3：IVR 1.3 deviceId integer True 目前设备id（技能队列skillId、IVR的id）

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

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

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

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

报文样例 请求头: Content-Type: application/jsonX-APP-KEY: **************************************Authorization: Bearer ************************************** 请求参数: {"phoneNo":"13020017****"} 响应参数: { "returnCode": "0", "data": { "areaCode": "110100", "province": "北京", "city": "北京", "cityCode": "010", "isp": "联通", "postCode": "100000", "phoneNo": "1302001" }, "description": "success"}

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-KEY string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 phoneNo string True 查询的11位手机号码，或者带区号固话。

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码，0成功，非0失败 1.2 description string False 返回描述 1.3 data object False 手机号码归属地信息 1.3.1 areaCode string False 地区码 1.3.2 province string False 省 1.3.3 city string False 城市 1.3.4 cityCode string False 城市编码，可能多个，"/"分隔，如果查询的是固话，城市编码可能为空 1.3.5 isp string False 运营商：电信、移动、联通。 如果是固话查询则返回未知 1.3.6 postCode string False 邮政编码，可能多个，"/"分隔，如果查询的是固话，邮政编码可能为空 1.3.7 phoneNo string False 手机号码前7位，或者固话区号 响应状态码: 401 授权失败：1. 参数是否正确有效。 2. 请确认是否购买了相关服务。 3. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求路径可能不对。 响应状态码: 500 参数不对导致业务失败或者服务端内部异常。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 accountPwd string True 座席当前密码，修改软电话密码时需要校验座席当前密码，如果校验失败三次，会锁账号，当前会在30分钟后解锁，也可以登入租户管理员账号人工解锁。 1.2 newPhonePwd string True 新软电话密码，长度8-16位（默认密码规则组），默认需要提供以下三种的任意组合：大写字母、小写字母、数字和特殊字符。 特殊字符支持 ~@^*_+.? 1.3 userAccount string True 座席账号

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

报文样例 请求头: x-app-key: 68b*************6ec8e4Content-Type: application/jsonAuthorization: Bearer xxx 请求参数: { "userAccounts": [ "x1", "x2" ], "skillId": 4, "agentWeight": 1, "skillWeight": 1} 响应参数: { "resultCode": "0", "resultMessage": "success"}

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 resultCode string True 请求成功为0，请求失败为1 1.2 resultMessage string False 请求失败，resultCode为1时会携带具体原因 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 userAccounts array True 座席账号数组，字符串型，长度最多不超过50 1.2 skillId integer True 技能队列ID 1.3 agentWeight integer True 座席权重，权重越高，越优先分配该座席，最低1 1.4 skillWeight integer True 技能队列权重，最低1

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True 请求成功 1.1 data array[object] False 返回数据 1.1.1 workNo number False 座席工号 1.1.2 agentType number False 座席类型： 4：音频座席； 11：视频座席 5：多媒体座席； 99：全能座席 1.1.3 agentWeight number False 座席权重，权重越高，越优先分配该座席，最低1 1.1.4 accountName string False 用户名称 1.1.5 sipAccount string False 软电话号码 1.1.6 skillWeight number False 技能队列权重，最低1 1.1.7 userAccount string False 座席账号，同创建座席的座席账号 1.2 count integer False 查询座席信息的数量 1.3 resultCode string False 请求成功返回0 ，请求失败返回1，会携带resultMessage，具体错误原因 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：根据技能队列ID查询座席信息 请求参数： { "skillId":3, "pageSize":10, "pageNum":0 } 响应参数： {"data": [ { "workNo": 107, "accountCode": "xxxxx", "agentType": 4, "agentWeight": 1, "accountName": "xxxxx", "sipAccount": "88880006", "skillWeight": 1 } ], "count": 1, "resultCode": "0" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 x-app-key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 requestParam object True 请求参数 1.1 skillId integer True 技能队列ID 1.2 pageSize integer True 分页大小，最大值为100 1.3 pageNum integer True 分页页号，从0开始

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 password string True CTI平台的工号密码（最大长度为32）。 2 phonenum string True 软电话号码（最大长度为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 是否启动话机联动（接续和硬话机联动控制，目前仅支持 CC组网下的 espace 7910 话机）。 默认为false。 11 checkInWebm boolean False 是否签入Webm媒体服务器。 默认为true。 12 checkInMailm boolean False 是否签入Mailm媒体服务器。 默认为false。 13 vcPhoneNumber string False VC号码（最大长度为24） 14 listenStatus boolean False 质检员是否侦听座席登录和登出的操作。 默认为false。 15 callBackUri string False 事件回调地址（事件回调地址） 接口定义可参考“推送事件回调接口”章节 16 serviceToken string False 认证码（最大长度50，不能包含特殊字符） 17 serviceworkid string False 业务工号（最大长度为30）。 callBackUri和serviceToken同时传入时才代表使用事件推送模式，否则依旧使用事件轮询模式。

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

响应说明 表4 响应头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 3 Set-GUID string True 值例如为“JSESSIONID=279fe2*****************0f5.AgentGateway0”其中279fe2*****************0f5.AgentGateway0为Guid 表5 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result Map 查询成功后，返回结果信息的对象。 该对象的参数说明请参见表6。 表6 result对象参数说明 序号 名称 参数类型 说明 3.1 vdnid string 虚拟呼叫中心ID。 3.2 workno string 座席工号。 3.3 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。如：TTF，表示CTIServer、WebM签入成功，MailM签入失败。 只有签入CTIServer成功，才能进行语音业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.4 loginTime string 签入时间，格式为时间戳。 3.5 isForceChange string 是否需要强制修改密码，如果为true，则座席登录后，必须修改密码。修改密码请调用修改密码(扩展)。 说明： 如果为true，没有修改密码，该座席无法进行通话。 3.6 serverName string 登录的CC-Gateway的集群名称。 3.7 timeRemaining string 密码剩余过期时间。 空字符串则表示座席密码永不过期。取值范围为0~180（天）。

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