Queues

Version 7.1 by michaely on 2015/07/10 16:50

For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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}/originate

Description

Originates a call from the specified extension.

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

JSON

{
"destinationNumber": "18005555555"
}

Properties:

Property	Type	Description
destinationNumber	String	The number to originate to.

POST

Originates a call from the specified extension to a destination number.

{instance_resource_path}/enableDnd

Description

Enables do not disturb on the specified extension.

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

POST

Enables do not disturb on the specified extension.

{instance_resource_path}/disableDnd

Description

Disables do not disturb on the specified extension.

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

POST

Disables do not disturb on the specified extension.

Curl Examples

Get all extensions 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/extensions

Get a specific extension 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/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23

Get all extensions bound to a user

Get a specific extension bound to a user

Get the extension related to a specific queue agent

Originate a call from a specific extension to a given number

curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"destinationNumber": "18005555555"}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23/originate

Enable DND on a specific extension

curl --user manager:manag3rpa55word -i -X POST http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/extensions/ef2faba9-8557-49c1-9ffc-5a71f41c7a23/enableDnd

Queues

Description

JSON Representation

Root Resource Paths

Instance Resource Paths

Sub Resource Paths

Action Paths

Curl Examples

Get all extensions in a core server

Get a specific extension in a core server

Get all extensions bound to a user

Get a specific extension bound to a user

Get the extension related to a specific queue agent

Originate a call from a specific extension to a given number

Enable DND on a specific extension

Disable DND on a specific extension