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

Querying a User Group Member

Scenario

This interface is invoked to query members in a specified user group based on the VDN, group ID, and workNo.

Interface Method

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

Request URL

https://ip:port/rest/cmsapp/v1/openapi/qcrelationconf/querygroupmemberbycondition

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 at 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.
Table 2 Parameters in the message body

Parameter

Type

Mandatory

Description

ccId

Integer

No

Call center ID. The value ranges from 1 to 65535.

  • 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.

vdn

Integer

Yes

ID of a VDN.

groupId

String

Yes

User group ID.

workNo

Integer

No

Agent ID. The value ranges from 0 to 99999.

limit

Integer

Yes

Maximum number of query records on each page (≤ 100).

offset

Integer

Yes

Offset.

Response Message

Table 3 Parameters in the message body

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 4.
Table 4 Parameters in the message body

Parameter

Type

Description

workNo

Integer

Agent ID.

accountCode

String

Account code.

groupName

String

Group name.

accountName

String

Account name.

ccRoleId

Integer

Role ID.

id

Integer

Primary key ID.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1,
    "vdn":113,
    "groupId":"159282396714302232563636876268",
    "limit":10,
    "offset":0
}
  • Response parameters 
    {
    "resultCode": "0100000",
    "resultDesc": [
        {
            "workNo": 1117,
            "accountCode": "HW513331117",
            "groupName": "Inspector group",
            "accountName": "HW972571117",
            "ccRoleId": 3,
            "id": "160526521924802293467767451224"
        },
        {
            "workNo": 1118,
            "accountCode": "HW340521118",
            "groupName": "Inspector group",
            "accountName": "HW972571118",
            "ccRoleId": 3,
            "id": "160526521924824882258144059275"
        }
    ]
}