Querying the Details About All Online Agents That Have Signed In to a Skill Queue

Prerequisites

The agent has signed in.

Description

This interface is used to query the details about all online agents that have signed in to a skill queue.

Interface Method

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

URI

https://ip:port/agentgateway/resource/agentgroup/{agentid}/allonlineagents

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

queryAllOnlineAgents

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	list	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	skillMediaType	int	Media type of a skill queue. The options are as follows: 1: text chat 2: click-to-dial call 4: callback request 5: common voice or video call 15: predicted outbound call 16: previewed outbound call 17: message call 19: common video call 51: multimedia web chat 53: social chat
3.2	skillId	int	ID of a skill queue.
3.3	agent	list	Agent details. For details about the parameters of this object, see Table 5.

**Table 5** Parameter description of agent
No.	Parameter	Value Type	Description
3.3.1	workno	string	Agent ID.
3.3.2	name	string	Agent name.
3.3.3	status	int	Status of an agent. For details, see Table 1.
3.34	ctiStatus	int	Platform status of an agent. For details, see Table 2.
3.3.5	groupid	int	Agent group ID.
3.3.6	groupname	string	It is not used.
3.3.7	skilllist	list	It is not used.
3.3.8	callids	list	It is not used.
3.3.9	mediatype	string	Whether the agent successfully signs in to the media server of a specific type. T indicates success and F indicates failure. The three characters indicate CTI Server, WebM, and MailM, respectively. The voice and video call business can be processed only after the agent successfully signs in to the CTI Server. The text chat business can be processed only after the agent successfully signs in to the WebM. Currently, the agent cannot sign in to the MailM.
3.3.10	vdnid	int	ID of the VDN to which a call belongs.
3.3.11	phonenumber	string	Agent phone number.
3.3.12	currentstatetime	long	Duration of the current state, in seconds.
3.3.13	logindate	long	Sign-in time, in milliseconds. The value is a timestamp.
3.3.14	inMultimediaConf	int	It is not used.
3.3.15	currentStateReason	int	Reason code of the current status.

Triggered Event

None

Error Code

100-006
100-007
600-005

Example

Message header

Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1

Request parameter
None

Response parameter

{
    "result": [
        {
            "skillId": 1,
            "agent": [
                {
                    "workno": "2005",
                    "name": "liukai011",
                    "status": "4",
                    "ctiStatus": "1",
                    "groupid": 0,
                    "groupname": null,
                    "skilllist": [],
                    "mediatype": "TFF",
                    "vdnid": 214,
                    "phonenumber": "88880026",
                    "currentstatetime": 527,
                    "logindate": 1616510142000,
                    "callids": [],
                    "inMultimediaConf": 0,
                    "currentStateReason": 0
                },
                {
                    "workno": "2007",
                    "name": "",
                    "status": "4",
                    "ctiStatus": "1",
                    "groupid": 0,
                    "groupname": null,
                    "skilllist": [],
                    "mediatype": "TTF",
                    "vdnid": 214,
                    "phonenumber": "88880027",
                    "currentstatetime": 28,
                    "logindate": 1616510634000,
                    "callids": [],
                    "inMultimediaConf": 0,
                    "currentStateReason": 0
                }
            ],
            "skillMediaType": 5
        },
        {
            "skillId": 2,
            "agent": [
                {
                    "workno": "2007",
                    "name": "",
                    "status": "4",
                    "ctiStatus": "1",
                    "groupid": 0,
                    "groupname": null,
                    "skilllist": [],
                    "mediatype": "TTF",
                    "vdnid": 214,
                    "phonenumber": "88880027",
                    "currentstatetime": 28,
                    "logindate": 1616510634000,
                    "callids": [],
                    "inMultimediaConf": 0,
                    "currentStateReason": 0
                }
            ],
            "skillMediaType": 53
        }
    ],
    "message": "success",
    "retcode": "0"
}

Parent topic: Skill Queue Management

Previous topic: Querying the Details About a Specified Agent

Next topic: Number Management