Help Center/ Customer Engagement Center/ API Reference/ Agent Operation Interface Reference/ Queue Device: queuedevice/ Obtaining the Total Number of Users in a Specified Skill Queue
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Obtaining the Total Number of Users in a Specified Skill Queue

Prerequisites

  • The agent has signed in.

Description

This interface is used to query the number of users in a specified skill queue of the current agent that has signed in.

Interface Method

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

URI

https://IP address:Port number/agentgateway/resource/queuedevice/{agentid}/skillwaitnum/{skillid}

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

No.

Parameter

Value Type

Mandatory

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

2

skillid

Integer

Yes

Skill queue ID.

Method Name in Logs

queryQueueLengthBySkillId

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory

    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

Integer

Indicates the number of users in a skill queue returned after a successful query.

No result is returned if the query fails.

Triggered Event

  • None

Error Code

  • 100-006

Example

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

    None

  • Response parameter 
    {
  "result": 1,
  "message": "success",
  "retcode": "0"
}