API : PBX : Queue Callers List

Introduction

A Queue item is a dialplan call distribution entity with advanced features for members and callers.

Request

This request returns a list of all the callers currently in the queue.

URL	https://api.telecomx.dk/pbx/queue/QUEUE_ID/callers
Method	GET
Access level	PERSONAL if user has access to the queue VIEWER, MANAGE, OWNER if queue items belongs to the customer RESELLER if customer belongs to the reseller ADMIN.
Params	QUEUE_ID	Id of queue to show callers in.

Query examples

https://api.telecomx.dk/pbx/queue/123458789012457890ABCD/callers

Response

Array of queue caller object.

JSON object
_id	String	Unique id of the call - <channel-id>-<hostname>.
state	String	State of caller: QUEUED - waiting to be answered CALLBACK - waiting to be answered but requires callback VIP - VIP caller waiting to be answered, not included when calculating position in queue.
number	String	Callers number.
name	String	Callers name - if available.
privacy	Boolean	True if callers number is secret.
entered	Date	Date and time when the caller entered the queue.
answered	Date	Date and time when the caller was answered (or called back).
presentation	String	The number the caller called. Used as a-number when doing callback.
answeredByExtension	Id	Extension id of member who answered the call.
answeredByNumber	String	Phone number of member who answered the call.

Example

[
  {
    _id: '46265y784.234-pbx1.telecomx.dk',
    state: 'QUEUED',
    number: '+4535203040',
    name: 'Bamse & Kylling',
    privacy: false,
    entered: '2018-01-01T00:00:00.000Z',
    answered: '2018-01-01T00:00:00.000Z',
    presentation: '+4570305050',
    answeredByExtension: null,
    answeredByNumber: null
  }
]

Errors

Error code	Message	Description
400	bad_request	Id not found in requestURI
404	id	Queue not found
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : PBX : Queue Callers List

Introduction

Request

Query examples

Response

Example

Errors