Obtaining Events of One Agent in Polling Mode

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

View PDF

Prerequisites

The agent has signed in successfully. If the agent has signed out, the interface invocation is stopped.
This interface is designed for obtaining associated events of all agents that have signed in to a specific CC-gateway. Use HTTPS to obtain data in long polling mode.
This mode allows users to obtain short-connection events of a single agent.
The serviceToken or callBackUri parameter is not carried during agent sign-in.

Description

This interface is used to obtain events of a single agent in polling mode.

NOTE:

If an agent has no event, the interface will return the response after 10 seconds. If the agent has events, the interface will return the response immediately. Modify configurations in the agentgateway/WEB-INF/config/basic.properties file as follows:

AGENT_POLL_WAIT_FLAG = ON //Whether an event is a waiting event. The value ON indicates that the server returns a response after 10 seconds if the agent has no event.

AGENT_POLL_WAIT_TIMES = 100 //Maximum number of waiting times when no event exists

AGENT_POLL_WAIT_INTERVAL = 100 //Waiting duration each time when no event exists (unit: millisecond)

Note: After waiting for the response to the request, the service invokes the interface again to obtain the event after 200 ms to 500 ms.

Interface Method

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

URI

https://ip:port/agentgateway/resource/agentevent/{agentid}?calldata=XXX

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.

No.	Parameter	Value Type	Mandatory (Yes/No)	Description
1	agentid	string	Yes	ID of the agent who signs in.
2	calldata	string	No	Call data. This parameter is used when the connection bar is updated.

Method Name in Logs

getAgentEvent

Request Description

Message Header

**Table 1** 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 2** 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	event	object	Indicates an agent event. For details about the parameters of this object, see Table 3.

**Table 3** Parameter description of event
No.	Parameter	Value Type	Description
3.1	eventType	string	Indicates the event type. For details, see Events.
3.2	workNo	string	Agent ID.
3.3	content	object	Indicates the content of an event. The definition varies with the event.

Triggered Event

None

Error Code

000-001
000-003
100-006

NOTE:

If any of the preceding error codes is displayed, you need to sign out the agent (or set the agent to the sign-out state) and stop obtaining the polling event. Wait until the agent signs in again.

In addition, in the HTTPS response description, if non-200 OK error code is displayed in status codes, the polling interval must be greater than 1 second to prevent the infinite loop that affects the intermediate network device or causes interception.

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",
    "event": {
        "eventType": "AgentOther_InService",
        "workNo": "291",
        "content": null
    }
}

Parent topic: Agent Event: agentevent

Previous topic: Agent Event: agentevent

Next topic: Calling Back Pushed Events