ListAgentQueueAndOnHoldCallData

Returns lists with call data of calls that were:
Placed on multihold by the requesting agent.
Queued, are ready to be handled and require a subset of the agent_skills provided.
Placed in the Hold Queue Monitor, haven't been picked up yet and require a subset of the agent_skills provided.
Required permissions:
NONE
Errors:

grpc.Invalid: the agent_session_sid provided in the request is invalid.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

agent_session_sid

integer <int64> | string

agent_session_sid

optional

current session id of the requesting agent.

agent_skills

array[string]

agent_skills

optional

list of skills (skill names) to use for matching queued calls, only calls that require a matching subset of agent_skills will be returned.

Example

{
    "agent_session_sid": 0,
    "agent_skills": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

agent_queue_calls

array[object (CallData) {9}]

agent_queue_calls

optional

calls that were queued and have a matching subset of the agent_skills from the request.

call_type

enum<string>

call_type

optional

call type of the found call.

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

start_date

string <date-time>

start_date

optional

timestamp indicating when the call started.

Examples:

1s1.000340012s

hold_date

string <date-time>

hold_date

optional

timestamp indicating when the call was put on hold (only set when call is a hold call).

Examples:

1s1.000340012s

queued_notification_type

enum<string>

queued_notification_type

optional

queued notification type of the call.

Allowed values:

QueuedNotificationType_GENERAL_INITIALQueuedNotificationType_PBX_INITIALQueuedNotificationType_AGENT_BOUND_INITIALQueuedNotificationType_GENERAL_REQUEUEDQueuedNotificationType_AGENT_BOUND_REQUEUED

phone_number

string

phone_number

optional

number dialed when the call was placed.

caller_id

string

caller_id

optional

caller_id used when the call was placed.

agent_specific

boolean

agent_specific

optional

indicates if the call is specific to the agent (multi-hold) or it can be picked up by multiple agents (queued and HQM calls).

call_sid

integer <int64> | string

call_sid

optional

id of the found call.

skills

array[string]

skills

optional

formatted skills that the call requires.

on_hold_calls

array[object (CallData) {9}]

on_hold_calls

optional

calls that were placed on multi-hold by the requesting agent.

call_type

enum<string>

call_type

optional

call type of the found call.

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

start_date

string <date-time>

start_date

optional

timestamp indicating when the call started.

Examples:

1s1.000340012s

hold_date

string <date-time>

hold_date

optional

timestamp indicating when the call was put on hold (only set when call is a hold call).

Examples:

1s1.000340012s

queued_notification_type

enum<string>

queued_notification_type

optional

queued notification type of the call.

Allowed values:

QueuedNotificationType_GENERAL_INITIALQueuedNotificationType_PBX_INITIALQueuedNotificationType_AGENT_BOUND_INITIALQueuedNotificationType_GENERAL_REQUEUEDQueuedNotificationType_AGENT_BOUND_REQUEUED

phone_number

string

phone_number

optional

number dialed when the call was placed.

caller_id

string

caller_id

optional

caller_id used when the call was placed.

agent_specific

boolean

agent_specific

optional

indicates if the call is specific to the agent (multi-hold) or it can be picked up by multiple agents (queued and HQM calls).

call_sid

integer <int64> | string

call_sid

optional

id of the found call.

skills

array[string]

skills

optional

formatted skills that the call requires.

hqm_calls

array[object (CallData) {9}]

hqm_calls

optional

calls that were placed in the Hold Queue Monitor, are still on hold by the destination (hold music is being played by the other party) and have a matching subset of the agent_skills from the request.

call_type

enum<string>

call_type

optional

call type of the found call.

Allowed values:

INBOUNDOUTBOUNDPREVIEWMANUALMAC

start_date

string <date-time>

start_date

optional

timestamp indicating when the call started.

Examples:

1s1.000340012s

hold_date

string <date-time>

hold_date

optional

timestamp indicating when the call was put on hold (only set when call is a hold call).

Examples:

1s1.000340012s

queued_notification_type

enum<string>

queued_notification_type

optional

queued notification type of the call.

Allowed values:

QueuedNotificationType_GENERAL_INITIALQueuedNotificationType_PBX_INITIALQueuedNotificationType_AGENT_BOUND_INITIALQueuedNotificationType_GENERAL_REQUEUEDQueuedNotificationType_AGENT_BOUND_REQUEUED

phone_number

string

phone_number

optional

number dialed when the call was placed.

caller_id

string

caller_id

optional

caller_id used when the call was placed.

agent_specific

boolean

agent_specific

optional

indicates if the call is specific to the agent (multi-hold) or it can be picked up by multiple agents (queued and HQM calls).

call_sid

integer <int64> | string

call_sid

optional

id of the found call.

skills

array[string]

skills

optional

formatted skills that the call requires.

Example

{
    "agent_queue_calls": [
        {
            "call_type": "INBOUND",
            "start_date": "1s",
            "hold_date": "1s",
            "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL",
            "phone_number": "string",
            "caller_id": "string",
            "agent_specific": true,
            "call_sid": 0,
            "skills": [
                "string"
            ]
        }
    ],
    "on_hold_calls": [
        {
            "call_type": "INBOUND",
            "start_date": "1s",
            "hold_date": "1s",
            "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL",
            "phone_number": "string",
            "caller_id": "string",
            "agent_specific": true,
            "call_sid": 0,
            "skills": [
                "string"
            ]
        }
    ],
    "hqm_calls": [
        {
            "call_type": "INBOUND",
            "start_date": "1s",
            "hold_date": "1s",
            "queued_notification_type": "QueuedNotificationType_GENERAL_INITIAL",
            "phone_number": "string",
            "caller_id": "string",
            "agent_specific": true,
            "call_sid": 0,
            "skills": [
                "string"
            ]
        }
    ]
}

🔴500Server Error