Help Center/ Customer Engagement Center/ API Reference/ Agent Operation Interface Reference/ Agent Operation Interfaces: onlineagent/ Querying Configured Skill Queues of Specified Agents
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying Configured Skill Queues of Specified Agents

Prerequisites

The agent has signed in.

Description

This interface is used by an agent that has signed in to query configured skill queue information of specified agents.

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/onlineagent/{agentid}/agentskillsbyworkno/{workno}

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 (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

2

workno

String

Yes

ID of an agent to be queried. The value ranges from 101 to 999999.

The agent ID must belong to the same VCC as the value of agentid.

Method Name in Logs

queryAgentSkillsByWorkNo

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

Object in the 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

name

String

Skill name.

3.2

id

Integer

Skill ID.

3.3

mediatype

Integer

Media type. 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

Triggered Event

None

Error Code

  • 100-006
  • 100-007

Example

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

    None

  • Response parameter 
    {
  "result": [
    {
      "name": "defaultMediaSkill",
      "id": 1,
      "mediatype": 53
    },
    {
      "name": "defaultAudioSkill",
      "id": 3,
      "mediatype": 5
    }
  ],
  "message": "success",
  "retcode": "0"
}