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

Getting Agent Status

Prerequisites

  • The agent has signed in.

Description

This interface is used to get the current status of the agent.

Interface Method

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

URI

https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentstatus

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.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

Method Name in Logs

getAgentStatus

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

3

result

array

For details, see Table 4.

Table 4 Agent Status Information

No.

Parameter

Value Type

Description

3.1

agentState

int

Agent status. For details, see Table 1.

3.2

isWorking

boolean

false: The agent is not talking.

true: The agent is talking.

Triggered Event

  • None

Error Code

  • 000-002

Example

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

    None

  • Response parameter
    {
        "message": "",
        "retcode": "0",
        "result": {
            "agentState": 4,
            "isWorking": false
        }
    }