API : PBX : Queue Member Update

Introduction

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

Request

This request updates a member on a queue.

URL	https://api.telecomx.dk/pbx/queue/QUEUE_ID/member/MEMBER_ID (POST)
	https://api.telecomx.dk/pbx/queue/QUEUE_ID/member/MEMBER_ID?priority=2
	https://api.telecomx.dk/pbx/queue/QUEUE_ID/member/MEMBER_ID?permanent=false
Method	GET, POST
Access level	PERSONAL, MANAGER, OWNER if queue items belongs to the customer, RESELLER if customer belongs to the reseller or ADMIN.
Params	QUEUE_ID	Id of queue.
Params	MEMBER_ID	Id of member.
Query/Body	priority	Priority of the member 1-20, if strategy is SEQUENTIAL. Lowest get calls first.
Query/Body	permanent	True if member is permanent, false if not (requires MANAGER and up to set).

Query example - using method POST

{
  priority: 5,
  permanent: false
}

Response

The updated 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: 5,
    calls: 0,
    seconds: 0,
    lastCallEnded: null,
    permanent: false
  }
]

Errors

Error code	Message	Description
400	bad_request	Id not found in requestURI
400	bad_request	No body found in request
404	id	Queue not found
404	member	Member not found
422	priority	Invalid priority, must be 1-20
403	dynamic	Cannot update on a queue which is not dynamic
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : PBX : Queue Member Update

Introduction

Request

Query example - using method POST

Response

Example

Errors