Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Inspection Relationship Maintenance Interfaces/ Deleting Members from a Group in Batches
Updated on 2023-12-19 GMT+08:00
View PDF

Deleting Members from a Group in Batches

Scenario

This interface is invoked to delete user group members in batches based on the VDN and agent ID set.

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/batchdeletegroupmember

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.

workNos

Array

No

Agent ID set of user group members. If this parameter is left empty, all group members under the tenant corresponding to the VDN are deleted.

The value of agent ID ranges from 0 to 99999.

vdn

Integer

Yes

ID of a VDN.

Response Description

Table 3 Parameters in the message body

Parameter

Type

Description

resultCode

String

Execution result. The options are as follows:

  • 0100000: success
  • Other values: failure
  • For details about the failure causes, see Error Code Reference.

resultDesc

String

Description of the result.

Message Example

  • Request header
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters
    {
   "ccId":1,
    "workNos":[57005,57006],
    "vdn":113
}
  • Response parameters
    { 
         "resultCode": "0100000",
         "resultDesc": "Deleted successfully"
}