Updating Agent Names

This interface supports only the scenario where the CC-CMS is independently deployed.

Scenario

This interface is invoked to update an agent name.

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

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.
vdnId	Integer	Yes	ID of a virtual call center. The value ranges from 1 to 5000.
agentId	Integer	Yes	Agent ID. The name of the VDN administrator cannot be changed, that is, the agent ID of the VDN administrator cannot be transferred. The value ranges from 0 to 99999.
agentName	String	Yes	Agent name. (The value cannot contain invalid characters.)

Response Message

**Table 3** Parameters in the message body
Parameter	Type	Description
message	String	Description.
retcode	String	Error code. The options are as follows: 0: success 1: failure
result	object	Object in the returned result after an agent is successfully added to a user group. For details about the parameters of this object, see Table 4.

**Table 4** Parameters of result
Parameter	Type	Description
ccId	Integer	VDN.
vdnId	Integer	ID of an inspector group.
agentId	Integer	New agent ID.
agentName	String	New agent name.

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters

{
    "ccId":1,
    "vdnId":4,
    "agentId":667,
    "agentName":"Zhang San"
}

Response parameters

{
    "result": {
        "agentId": "6667",
        "ccId": 1,
        "vdnId": 4,
        "agentName": "Li Si"
    },
    "message": "success",
    "retcode": "0"
}

Parent topic: Inspection Relationship Maintenance Interfaces

Previous topic: Adding an Agent to a User Group

Next topic: Querying Outbound Call Task Lists