Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Inspection Relationship Maintenance Interfaces/ Querying All User Groups
Updated on 2023-12-19 GMT+08:00
View PDF
Share

Querying All User Groups

Description

This interface is invoked to query all user groups in a VDN based on the VDN.

Interface Method

The request method must be set to GET. This interface supports only the GET method.

Request URL

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

The ccId parameter is optional. If it is left empty, in the independent deployment environment, the default value is the value of Default Call Center ID on the Configuration Center > System Management > Parameter Settings page after a system administrator signs in to the AICC.

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.In a non–public cloud environment where the NSLB service is configured, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.

Response Message

Table 2 Parameter description

Parameter

Type

Description

resultCode

string

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure

For details about the failure causes, see Error Code Reference.

resultDesc

Array

Object array in the returned result after a successful query.

For details about the parameters of this object, see Table 3.
Table 3 Parameter description

Parameter

Type

Description

groupName

String

User Group Name

groupType

Integer

User Group Type

remark

String

Remarks.

id

String

Primary key ID of a user group.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • No request message exists.
  • Response parameters 
    {
    "resultCode":"0100000",
    "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": "Inspector group",
            "groupType":3,
            "id":"159832671551117675139418726647"
        }
    ]
}