Updated on 2025-11-13 GMT+08:00

Obtaining Token Information

Prerequisites

  • The agent has signed in.

Description

After an agent signs in, a temporary token needs to be obtained as the password for softphone number registration in the multi-account unified authentication scenario.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/logininfo

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

Table 1 Parameter in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

String

True

Agent ID. The value ranges from 101 to 999999.

Method Name in Logs

loginInfo

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    String

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    String

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

  • Message body

    None

Response Description

Table 3 Parameters in the message body

No.

Parameter

Value Type

Description

1

message

String

Description.

2

retcode

String

Error code. The options are as follows:

  • 0: success
  • Other values: failure

For details, see Error Code.

3

result

Object

Object in the returned result after a successful query.

For details about the parameters of this object, see Table 4.

Table 4 Parameter description of result

No.

Parameter

Value Type

Description

3.1

phonetoken

String

Temporary token.

3.2

phonenum

String

Softphone number used by an agent to sign in.

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter
    {
        "result": {
                "phonenum": "88880001",
                "phonetoken": "XXX"    
         },
        "message": "success",
        "retcode": "0"
    }