Updated on 2025-11-13 GMT+08:00

Querying the Details About a Specified Agent

Prerequisites

  • The agent has signed in.

Description

This interface is used to query the details about a specified agent by agent ID after the agent 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/agentgroup/{agentid}/agentbyworkno/{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

queryAgentInfoByWorkNo

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

Object

Return result of a successful query, that is, a list of agents.

For details about the parameters of this object, see Table 4.

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

Indicates an agent skill object list.

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

3.8

callids

List

It is not used.

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. Voice and video call businesses can be handled only after the agent successfully signs in to the CTI Server. Text chat businesses can be handled 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 VCC to which a call belongs.

3.11

phonenumber

String

Agent phone number.

3.12

currentstatetime

Long

Duration of the current status, in seconds.

3.13

logindate

Long

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

3.14

inMultimediaConf

Integer

Indicates whether n agent is in a multimedia conference. The options are as follows:

0: no

1: yes

3.15

currentStateReason

Integer

Cause code of the current status.

3.16

preRestFlag

Boolean

Whether an agent is in pre-rest state.

  • true: yes
  • false: no
NOTE:

In the fully containerized scenario, the containerized CTI is not supported. Therefore, the containerized CC-Gateway is not supported.

3.17

preBusyFlag

Boolean

  • Whether an agent is in pre-busy-indicating state.
  • true: yes
  • false: no
NOTE:

In the fully containerized scenario, the containerized CTI is not supported. Therefore, the containerized CC-Gateway is not supported.

Table 5 Parameter description of skilllist

No.

Parameter

Value Type

Description

3.7.1

name

String

Skill name.

3.7.2

id

Integer

Skill ID.

3.7.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
    {
        "message": "",
        "retcode": "0",
        "result": {
            "workno": "20011",
            "name": "20011",
            "status": "4",
            "ctiStatus": "1",
            "groupid": 1,
            "groupname": "jst",
            "skilllist": [
                {
                    "name": "clicktodial_jst",
                    "id": 10,
                    "mediatype": 2
                },
                {
                    "name": "callback",
                    "id": 2,
                    "mediatype": 4
                },
                {
                    "name": "webchat",
                    "id": 3,
                    "mediatype": 1
                },
                {
                    "name": "email",
                    "id": 4,
                    "mediatype": 6
                },
                {
                    "name": "voice_hym",
                    "id": 5,
                    "mediatype": 5
                },
                {
                    "name": "voice",
                    "id": 6,
                    "mediatype": 5
                },
                {
                    "name": "webchat_jst",
                    "id": 9,
                    "mediatype": 1
                }
            ],
            "mediatype": "TTT",
            "vdnid": 6,
            "phonenumber": "70942",
            "currentstatetime": 1210,
            "logindate": 1501125758000,
            "callids": [],
            "inMultimediaConf": 0,
            "currentStateReason": 0,
            "perRestFlag": false,
            "perBusyFlag": false
        }
    }