Help Center/ Cognitive Engagement Center/ API Reference/ Call Center Configuration Interface Reference/ Skill Queue Management/ Querying Information About Agents That Have Signed In to a Skill Queue
Updated on 2025-03-31 GMT+08:00
View PDF
Share

Querying Information About Agents That Have Signed In to a Skill Queue

Prerequisites

  • The agent has signed in.
  • The agent has the permission to answer inbound calls.

Description

This interface is used by an agent that has logged in to query the detailed information about agents that have signed in to a skill queue by skill queue ID.

If the agent has the permission to reject inbound calls, the query result does not contain 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/agentgroup/{agentid}/agentbyskill/{skillid}

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 Parameters in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

string

Yes

Agent ID. The value ranges from 101 to 59999.

2

skillid

Integer

Yes

ID of the skill queue to be queried.

Method Name in Logs

queryAgentInfoBySkillId

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
    Table 3 Parameters in the message body

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    agentLimit

    Integer

    No

    Maximum number of agents to be queried. The value ranges from 1 to 500.

    NOTE:

    If agentLimit is set, agentStatus must be set. Otherwise, this configuration does not take effect.

    2

    agentStatus

    array

    No

    Status list of the agents to be queried. For details about the status, see Table 1.

Response Description

Table 4 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

Indicates the return result of a successful query, that is, a list of agents.

For details about the parameters of this object, see Table 5.
Table 5 Parameter description of result

No.

Parameter

Value Type

Description

3.1

workno

string

Agent ID.

3.2

name

string

Agent name.

3.3

status

Integer

Status of an agent. For details, see Table 1.

3.4

ctiStatus

Integer

Platform status of an agent. For details, see Table 2.

3.5

groupid

Integer

Agent group ID.

3.6

groupname

string

It is not used.

3.7

skilllist

list

It is not used.

3.8

callids

list

It is not used.

3.9

mediatype

string

Indicates whether the agent successfully signs in to the media server. The parameter value consists of three characters. In the parameter value, 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.10

vdnid

Integer

ID of the VDN to which a call belongs.

3.11

phonenumber

string

Agent phone number.

3.12

currentstatetime

long

Duration of the current state, in seconds.

3.13

logindate

long

Sign-in time. The value is a timestamp, in milliseconds.

3.14

inMultimediaConf

Integer

It is not used.

3.15

currentStateReason

Integer

Reason code of the current status.

Triggered Event

  • None

Error Code

  • 100-006
  • 100-007
  • 300-002
  • 100-019

Example

  • Message header 
    Content-Type:application/json; charset=UTF-8
Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter 
    {
   "agentLimit":1,
   "agentStatus":[4,7]
}
  • Response parameter 
    {
    "message": "",
    "retcode": "0",
    "result": [
        {
            "workno": "20011",
            "name": "20011",
            "status": "4",
            "ctiStatus": "1",
            "groupid": 1,
            "groupname": null,
            "skilllist": [],
            "mediatype": "TTT",
            "vdnid": 6,
            "phonenumber": "70942",
            "currentstatetime": 1376,
            "logindate": 1501125758000,
            "callids": [],
            "inMultimediaConf": 0,
            "currentStateReason": 0
        }
    ]
}
Parent topic: Skill Queue Management