Queues

Last modified by michaely on 2021/09/10 23:34

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

The information on this page applies to iSymphony 3.2+.

This resource is restricted by licensing. See the resource and action path information below for more details.

Description

The live queue REST resource provides access to information about queues in the system. This resource also provides actions to log extensions in and out of queues.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

JSON Representation

{
"id": "4f302d40-bd94-4fdd-8129-cf53ed68cb5e",
"displayName": "IncomingQ",
"identifier": "5001",
"configurationId": "c46f4e60-aba2-4340-a6a5-0c7304d40ba1",
"permissionId": "c46f4e60-aba2-4340-a6a5-0c7304d40ba1"
}

Property	Type	Description
id	String	The id of the queue.
displayName	String	The display name of the queue.
identifier	String	The identifier of the queue.
configurationId	String	The id of the configuration object that represents the queue.
permissionId	String	The queue's permission id.

Root Resource Paths

Paths used to access sets of the resource, in relation to parent resources.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/queues
Description	Provides access to all queues in the specified core server. Information Excludes any queues that are not enabled. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets all queues in the specified core server.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{queue_id}
Description	Provides access to a specific queue, by queue id. Information This resource will not be available if the queue is not enabled. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above queue_id: the id of the queue to access Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no queue with the specified queue id could be found 403 Forbidden: Returned if the specified queue is not enabled
GET	Gets the specified queue.

{root_resource_path}/getByName/{queue_identifier}
Description	Provides access to a specific queue, by queue identifier. Information This resource will not be available if the queue is not enabled. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above queue_identifier: the identifier of the queue to access Errors: 404 Not Found: Returned if any of the ancestors in the root resource path could not be found 404 Not Found: Returned if no queue with the specified queue identifier could be found 403 Forbidden: Returned if the specified queue is not enabled
GET	Gets the specified queue.

Sub Resource Paths

Paths used to access the child resources of this resource.

{instance_resource_path}/agents
Description	Provides access to all the agents logged into the specified queue. See Agents. Information This resource will not be available if the queue is not enabled. Excludes any agents that are not related to an extension that is bound to a licensed/full user. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
GET	Gets all the agents logged into the specified queue.

{instance_resource_path}/callSegments
Description	Provides access to the call segments waiting in the specified queue. See Call Segments. Information This resource will not be available if the queue is not enabled. Excludes any call segments that are not related to an extension that is bound to a licensed/full user, or have not been bound to another call segment that is related to an extension that is bound to a licensed/full user. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
GET	Gets all the call segments waiting in the specified queue.

{instance_resource_path}/statistics
Description	Provides access to all statistics of the queue. See Statistics. Information This resource will not be available if the queue is not enabled. Parameters: instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above Errors: 404 Not Found: Returned if any of the ancestors in the instance resource path could not be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted
GET	Gets all statistics for the specified queue.

Action Paths

Actions that can be performed on this resource.

{instance_resource_path}/loginAgent

Description

Logs an extension into a specified queue, as an agent.

This action will not be available if the queue is not enabled.

This action will not be available if the extension is not bound to a licensed/full user.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
403 Forbidden: Returned if the queue is not enabled
403 Forbidden: Returned if if the extension is not bound to a licensed/full user
422 Unprocessable Entity: Returned if the extension with the specified id or extension number could not be found
422 Unprocessable Entity: Returned if the extension with the specified id or extension number is already a member of the queue
422 Unprocessable Entity: Returned if no information was provided to identify the extension to log into the queue

JSON

The extension to log into the queue can be identified by the extension id or the extension number. If both are provided the extension id will be used.

{
"extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
}

OR

{
"extensionNumber": "100"
}

Properties:

Property	Type	Description
extensionId	String	The id of the extension to log into the queue.
extensionNumber	String	The number of the extension to log into the queue.

POST

Log an extension into a specified queue, as an agent.

{instance_resource_path}/logoutAgent

Description

Logs a specified agent out of the queue.

This action will not be available if the queue is not enabled.

This action will not be available if the extension is not bound to a licensed/full user.

Parameters:

instance_resource_path: One of the instance resource paths for this resource. See Instance Resource Paths above

Errors:

404 Not Found: Returned if any of the ancestors in the instance resource path could not be found
403 Forbidden: Returned if if the extension is not bound to a licensed/full user
403 Forbidden: Returned if the queue is not enabled
422 Unprocessable Entity: Returned if the agent with the specified id could not be found
422 Unprocessable Entity: Returned if the agent with the specified extension id or extension number could not be found
422 Unprocessable Entity: Returned if no information was provided to specify the agent to log out of the queue

JSON

The agent to log out of the queue can be identified by the agent id, extension id, or extension number. If more than one identifier is provided the agent id will be used, if provided. If the agent id is not provided the extension id will be utilized.

{
"agentId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
}

OR

{
"extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"
}

OR

{
"extensionNumber": "100"
}

Properties:

Property	Type	Description
agentId	String	The id of the agent to log out of the queue.
extensionId	String	The id of the extension to log out of the queue.
extensionNumber	String	The number of the extension to log out of the queue.

POST

Log a specified agent out of the queue.

Curl Examples

Get all queues in a core server

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues

Get a specific queue in a core server

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e

Log a specific extension into a queue as an agent

curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"extensionId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e/loginAgent

Log a specific agent out of a queue

curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"agentId": "ef2faba9-8557-49c1-9ffc-5a71f41c7a23"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/queues/7a2eeb64-24e1-418f-97fd-28880ba6539e/logoutAgent