更新时间:2023-12-19 GMT+08:00

查询所有用户组

场景描述

根据vdn查询该vdn下所有用户组

接口方法

设置成“GET”。该接口仅支持GET方法,不支持PUT、POST和DELTE等方法。

请求URL

https://ip:port/rest/cmsapp/v1/openapi/qcrelationconf/queryallccgroup/{ccId}/{vdn}

其中,ccId为非必填,不填的话,独立部署环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > 参数配置查看“默认呼叫中心标识”的值。

公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

响应消息

表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

样例报文

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 无请求消息
  • 响应参数:
    {
        "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"
            }
        ]
    }