Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Agent Operation Interfaces: onlineagent/ Querying Configured Skill Queues of Specified Agents
Updated on 2023-09-27 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:port/agentgateway/resource/onlineagent/{agentid}/agentskillsbyworkno/{workno}

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

workno

string

Yes

ID of the agent to be queried. The value ranges from 101 to 59999.

The agent ID must belong to the same VDN 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

int

Indicates the ID of a skill.

3.3

mediatype

int

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"
}