华为云用户手册

  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数 无。 响应参数: { "result": "0", "resultCode": "0100000", "count": 101, "resultDatas": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ], "resultDesc": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ]}
  • 请求URL https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn}/{offset}/{limit} 其中,ip为NSLB的服务器IP地址,port为CC-CMS服务在NSLB映射的HTTPS端口号,{ccId}为呼叫中心ID,取值范围:1~65535,{vdn}为虚拟呼叫中心ID,取值范围:1~5000,{offset}为查询起始偏移量,非必填,{limit}表示每页的查询数量,最大100,非必填,{offset}和{limit}需同时传递才生效。
  • 响应消息 表3 相应消息参数体说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDesc object 查询成功后,返回结果信息的对象。 该数组中对象的参数说明请参见表3 resultDesc对象参数说明。 表4 resultDesc对象参数说明 参数名 数据类型 说明 ccId int 呼叫中心编号。 tenantId string 租间ID。 tenantSpaceName string 租间名称 vdnId int 虚拟呼叫中心编号 accessCodes array 接入号列表。 该数组中对象的参数说明请参见“表4 accessCodes 对象参数说明”。 agents array 座席列表。参见“表5 agents对象参数说明” 表5 accessCodes 对象参数说明 参数名 数据类型 说明 accessCode string 接入号。 isDefault boolean 默认接入码标识,true:默认接入码,false或者空:非默认接入码。 表6 agents对象参数说明 参数名 数据类型 说明 workNo int 座席工号。 sipAccount string 软电话号码。 accountCode string 座席账号。 agentType int 座席类别。取值如下: 4:音频座席 5:多媒体座席 11:视频座席,只在集成部署时返回此字段。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "tenantId": "202008142460", "ccId": 1} 响应参数: { "resultCode": "0100000", "resultDesc": { "ccId": 3, "vdnId": 47, "tenantId": "202008142460", "accessCodes": [ { "accessCode": "202008191", "isDefault": true } ], "tenantSpaceName": "fjw081401", "agents": [{ "workNo": 111, "sipAccount": "88880001", "accountCode": "123", "agentType": 4 }] }}
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数 无。 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "ccId": 1, "vdnId": 1, "accessCode": "6045", "subCode": "1110", "deviceType": "1", "deviceName": "test", "deviceNo": "22", "dnid": "22" } ], "resultDesc": [ { "ccId": 1, "vdnId": 1, "accessCode": "6045", "subCode": "1110", "deviceType": "1", "deviceName": "test", "deviceNo": "22", "dnid": "22" } ]}
  • 响应消息 表2 响应消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 表3 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 ccId int 呼叫中心ID。 2.2 vdnId int 虚拟呼叫中心ID。 2.3 accessCode string 接入码。 2.4 subCode string 后续接入码。 最大长度:100。 取值:0123456789*#。 2.5 deviceType string 设备类型,请参见表1 返回值的类型为四字节整数。 2.6 deviceName string 设备名称。当设备类型为1:技能队列时,设备名称为技能队列名称;当设备类型为3:IVR自动流程时,设备名称为流程描述。 2.7 deviceNo string 设备编号。 2.8 dnid string 配置编号。
  • 响应消息 表2 消息体参数说明 序号 名称 参数类型 说明 1 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 2 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表3 表3 resultDesc对象参数说明 序号 名称 参数类型 说明 2.1 id int 技能组id 2.2 skills array 技能对象数组,数组中为技能对象。单个技能对象的定义如 表4所示 2.3 groupName String 技能组名称。 最大长度为64字节,不含特殊字符。 表4 skills对象参数说明 序号 名称 参数类型 说明 2.2.1 skillId int 技能队列编号。 取值类型为整数,根据实际的技能队列编号填写。 2.2.2 skillPower int 技能队列对应的技能权值。 取值类型为整数,取值范围为1~100 2.2.3 agentPower int 技能队列对应的座席权值。 取值类型为整数,取值范围为1~300
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: 无 响应参数: { "resultCode": "0100000", "resultDesc": [ { "id": 2, "skills": [ { "skillId": 2, "skillPower": 1, "agentPower": 1 } ], "groupName": "skillgroup2" } ]}
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description array 查询成功后,返回结果信息的对象数组。 该对象的参数说明请参见表4 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后,返回结果信息的对象数组。 该对象的参数说明请参见表4 表4 消息体参数说明 参数名 数据类型 说明 workNo int 座席工号 accountCode String 账户编码 groupName String 组名称 accountName String 账户名 ccRoleId int 角色id id int 主键id
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "vdn":113, "groupId":"159282396714302232563636876268", "limit":10, "offset":0} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": [ { "workNo": 1117, "accountCode": "HW513331117", "groupName": "质检组", "accountName": "HW972571117", "ccRoleId": 3, "id": "160526521924802293467767451224" }, { "workNo": 1118, "accountCode": "HW340521118", "groupName": "质检组", "accountName": "HW972571118", "ccRoleId": 3, "id": "160526521924824882258144059275" } ], "resultDesc": [ { "workNo": 1117, "accountCode": "HW513331117", "groupName": "质检组", "accountName": "HW972571117", "ccRoleId": 3, "id": "160526521924802293467767451224" }, { "workNo": 1118, "accountCode": "HW340521118", "groupName": "质检组", "accountName": "HW972571118", "ccRoleId": 3, "id": "160526521924824882258144059275" } ]}
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId": 1} 响应参数: { "resultCode": "0100000", "resultDesc": [ { "ccId": 3, "vdnId": 47, "tenantId": "202008142460", "accessCodes": [ { "accessCode": "202008191", "isDefault": true } ], "tenantSpaceName": "fjw081401" } ]}
  • 响应消息 表3 相应消息参数体说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc对象参数说明 参数名 数据类型 说明 ccId int 呼叫中心编号。 tenantId string 租间ID。 tenantSpaceName string 租间名称。 vdnId int 虚拟呼叫中心编号。 accessCodes array 接入号列表。 该数组中对象的参数说明请参见表5。 表5 accessCodes 对象参数说明 参数名 数据类型 说明 accessCode string 接入码。 isDefault boolean 默认接入码标识,true:默认接入码,false或者空:非默认接入码。
  • 响应说明 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "workNos":[57005,57006], "vdn":113} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "删除成功", "resultDesc": "删除成功"}
  • 响应说明 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "vdn":113, "workNos":[57005,57006], "groupId":"159774518399110207461019283363"} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "新增成功", "resultDesc": "新增成功"}
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数 无 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": [ { "groupName": "ceshi001", "groupType": 3, "id": "159253664007418170345218084185" }, { "groupName": "ceshi002", "groupType": 2, "id": "159253664765739060254053779940" }, { "groupName": "ceshi003", "groupType": 3, "id": "159253666192354492596520647666" }, { "groupName": "ceshi004", "groupType": 2, "id": "159253667128968076722272915560" }, { "groupName": "ceshi005", "groupType": 3, "id": "159289723573509154577931092749" }, { "groupName": "ceshi445566", "remark": "此为质检组", "groupType": 3, "id": "159832671551117675139418726647" } ], "resultDesc": [ { "groupName": "ceshi001", "groupType": 3, "id": "159253664007418170345218084185" }, { "groupName": "ceshi002", "groupType": 2, "id": "159253664765739060254053779940" }, { "groupName": "ceshi003", "groupType": 3, "id": "159253666192354492596520647666" }, { "groupName": "ceshi004", "groupType": 2, "id": "159253667128968076722272915560" }, { "groupName": "ceshi005", "groupType": 3, "id": "159289723573509154577931092749" }, { "groupName": "ceshi445566", "remark": "此为质检组", "groupType": 3, "id": "159832671551117675139418726647" } ]}
  • 响应消息 表2 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description array 查询成功后,返回结果信息的对象数组。 该对象的参数说明请参见表3 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后,返回结果信息的对象数组。 该对象的参数说明请参见表3 表3 消息体参数说明 参数名 数据类型 说明 groupName String 用户组名称 groupType int 用户组类型 remark String 备注信息 id String 用户组主键id
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "vdn":113, "groupName":"ceshipostman", "groupType":3, "remark":"此为质检组", "workNos":[50041,50042]} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "新增成功", "resultDesc": "新增成功"}
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "groupName":"ceshi445566", "remark":"此为质检组", "id":"159832671551117675139418726647", "vdn":113} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "更新成功", "resultDesc": "更新成功"}
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 message string 描述 retcode string 错误码。取值如下: 0:成功 非0:失败 错误码的参数说明请参见表5。 result object 加入成功后,返回结果信息的对象。该对象的参数说明请参见表4。 表4 result对象参数说明 参数名 数据类型 说明 groupId string 座席加入的用户组编号 groupName string 座席加入的用户组名称 取值范围:不允许非法字符,长度不超过20。 表5 错误结束码说明 错误结束码 说明 处理意见 300-010 VDN用户ccid和vdnid匹配错误 检查输入参数是否正确。 300-016 VDN下不存在此座席 检查VDN下是否存在该座席,如果存在建议1分钟后重试一次 300-017 质检用户组名已存在 更改待创建的质检用户组名称 300-018 质检用户组名为空 检查是否携带groupName参数或者其值是否为空 300-019 待加入的质检用户组不存在 检查groupId对应的质检用户组是否存在 1 参数不合法或系统报错 检查输入参数是否正确。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "vdnId":4, "agentId":667, "groupId":"159282396714302232563636876268", "groupName":"话务组", "groupType":""} 响应参数: { "result": { "groupName": "话务组A", "groupId": "161960203515344228641565404173" }, "message": "success", "retcode": "0"}
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "id":"159832684658001135254942692203", "vdn":113} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "删除成功", "resultDesc": "删除成功"}
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "qcGroupId":"159282396714302232563636876268", "inspectedGroupIds":["159253666192354492596520647666"], "vdn":113} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "删除配置成功", "resultDesc": "删除配置成功"}
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 returnCode String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 执行结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 description String 结果描述 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc String 结果描述
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8Authorization: ****************** 请求参数: { "ccId":1, "qcGroupId":"159282396714302232563636876268", "inspectedGroupIds":["159253666192354492596520647666"], "vdn":113} 响应参数: { "returnCode": "0", "resultCode": "0100000", "description": "配置成功", "resultDesc": "配置成功"}
共100000条