Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Control/ Call Data (calldata)/ Querying All Calls Placed on Hold by a Specified Agent
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying All Calls Placed on Hold by a Specified Agent

Prerequisites

  • The inspector and specified agent have signed in.
  • The specified agent is in a call and holds the call.

Description

This interface is used by an inspector who has signed in to query the calls placed on hold by a specified agent in the same VDN.

Interface Method

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

URI

https://ip:port/agentgateway/resource/calldata/{agentid}/holdlistex/{workno}

In the URL, ip indicates the IP address of the agent gateway server, and port indicates the HTTPS port number of the agent 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

queryHoldListInfoEx

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

list

Indicates the query result. After the query is successful, the system returns the list of call information objects in the queue.

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

No.

Parameter

Value Type

Description

3.1

callfeature

int

Call type. For details, see Call Type.

3.2

callid

string

Call ID.

3.3

caller

int

Calling number.

3.4

called

int

Called number.

3.5

callskill

string

Call skill description.

Triggered Event

  • None

Error Code

  • 100-006

  • 100-007

  • 300-001

  • 400-003

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": [
        {
            "callfeature": 7,
            "callid": "1501127996-2",
            "caller": "10086",
            "called": "70943",
            "callskill": "voice"
        },
        {
            "callfeature": 7,
            "callid": "1501127920-0",
            "caller": "10086",
            "called": "70941",
            "callskill": ""
        }
    ]
}
Parent topic: Call Data (calldata)