Table of Contents

API : PBX : Queue Member Join

Introduction

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

Request

This request adds a member to a queue.

URL https://api.telecomx.dk/pbx/queue/QUEUE_ID/member (POST)
https://api.telecomx.dk/pbx/queue/QUEUE_ID/member/join?extension=12345678901234567890ABCD (GET)
https://api.telecomx.dk/pbx/queue/QUEUE_ID/member/join?number=+4571919998 (GET)
Method GET, POST
Access level PERSONAL, MANAGE, OWNER if queue items belongs to the customer, RESELLER if customer belongs to the reseller or ADMIN.
Params QUEUE_ID Id of queue to add the member to.
Query/Body extension Id of the extension to add to the queue.
number … or… external phone number to add to the queue.
priority Priority of the member 1-20, if strategy is SEQUENTIAL. Lowest get calls first. Default 1.
permanent True if member is permanent and requires at least a MANAGER to be removed. Default false. (MANAGER and up only).

Query examples - using method POST

{
  extension: '12345678901234567890ABCD',
  priority: 1,
  permanent: true
}
{
  number: '+4571919998'
}

Response

The added queue member.

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.
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,
    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
400 bad_request No body found in request
404 extension Extension not found
409 member Is already a member
403 dynamic Cannot join a queue which is not dynamic
409 extension Only extensions may join this queue
403 extension Extension is not permitted to join the queue
422 priority Invalid priority, must be 1-20
403 access_denied Insufficient access level
500 internal_error <Unspecified>