C5 Intelligent Auxiliary Interface Authentication

Updated on 2023-09-27 GMT+08:00

View PDF

Description

This interface is used to perform authentication upon sign-in. When this interface is invoked, the request must contain the system administrator ID or VDN administrator ID, and the corresponding password. The system administrator ID is used to modify system configurations and the VDN administrator ID is used to modify VDN configurations. Upon successful sign-in authentication, the response header contains Guid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1. When a configuration interface is invoked subsequently, the Guid header field must be carried.

Interface Method

This interface supports only the POST method.

URI

https://ip:port/agentgateway/resource/config/login

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Method Name in Logs

auth

Request Description

Message header

**Table 1** Parameter in the message header
No.	Parameter	Value Type	Mandatory	Description
1	Content-Type	String	Yes	Coding mode of the message body. The default value is application/json; charset=UTF-8.

Message body

**Table 2** Parameters in the message body
No.	Parameter	Value Type	Mandatory	Description
1	agentId	Number	Yes	1. Configure the agent ID for the administrator to log in. The value is an integer ranging from 1 to 59999. 2. When a VDN account is used for login, the value is a number consisting of the VDN ID and 100000.
2	password	String	Yes	1. Configure the password corresponding to the employee ID for the administrator to log in. 2. When a VDN account is used for login, the value is the password for connecting to the VDN.

Response Description

**Table 3** Parameters in the message body
No.	Parameter	Value Type	Description
1	message	String	Response message.
2	retcode	String	Error code. The options are as follows: 0: success Others: failure. For details, see Error Codes.
3	result	Object	Result content object. For details about the parameters of this object, see Table 4.

**Table 4** Parameter of result
No.	Parameter	Value Type	Description
3.1	guid	String	GUID, which is assigned to each configuration user upon sign-in.

Example

Message header

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

Request parameter

{
    "agentId": 101,
    "password": "******"
}

Response parameter

{
    "result": {
        "guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1"
    },
    "message": "success",
    "retcode": "0"
}

Parent topic: Interface Authentication Modes

Previous topic: C4 Agent Operation Interface Authentication

Next topic: Call Center Configuration Interface Reference

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot