API : PBX : Queue Members 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 members of the queue.

URL	https://api.telecomx.dk/pbx/queue/QUEUE_ID/member
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 members of.

Query examples

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

Response

Array of queue member object.

JSON object
_id	String	Unique id of the member. Used when removing member from the queue.
extension	Id	Id of a member extension, null if member is external.
number	String	Phone number of external member. Null if member is extension.
name	String	Name of the member. Employee's name if extension is used, or name from phonebook - if available.
priority	Number	Priority of member in the queue, 1-20, lower gets calls first. Defaults to 1.
calls	Number	Number of calls answered today.
seconds	Number	Number of seconds talking to queue callers today.
lastCallEnded	Date	Date and time the member ended the last call.
permanent	Boolean	If true, the member cannot leave the queue. It can only be done via API/Web by a MANAGER or higher.

Example

[
  {
    _id: '12345678901234567890DADA',
    extension: '1234567890124567890DBDB',
    number: null,
    name: 'Donald Duck',
    priority: 1,
    calls: 0,
    seconds: 0,
    lastCallEnded: null,
    permanent: false
  }
]

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 Members List

Introduction

Request

Query examples

Response

Example

Errors