C5 Intelligent Auxiliary Interface Authentication

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

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"
  }