Extensions

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 extension REST resource provides access to information about extensions in the system. This resource also provides actions for originating calls, and enabling/disabling Do Not Disturb on an extension.

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": "e640205f-bc76-4db4-8e03-bf34eb33a8ce",
"extensionNumber": "4224",
"displayName": "Michael Y",
"configurationId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f",
"permissionId": "813936dd-98a4-4ccc-8bcf-dd1f27673c1f"
}

Property	Type	Description
id	String	The id of the extension.
extensionNumber	String	The number used to call the extension.
displayName	String	The display name of the extension.
configurationId	String	The id of the configuration object that represents the extension.
permissionId	String	The extension'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}]/extensions
Description	Provides access to all extensions in a specified core server. Information Excludes any extensions that are not bound to a licensed/full user. 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 extensions in the specified core server.

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

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource_path}/{extension_id}
Description	Provides access to a specific extension, by extension id. Information This resource will not be available if the extension is not bound to a licensed/full user. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above extension_id: the id of the extension 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 extension with the specified extension id could be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted 403 Forbidden: Returned if the extension is not bound to a licensed/full user
GET	Gets the specified extension.

{root_resource_path}/getByName/{extension_number}
Description	Provides access to a specific extension, by extension number. Information This resource will not be available if the extension is not bound to a licensed/full user. Parameters: root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above extension_number: the extension number of the extension 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 extension with the specified extension number could be found 403 Forbidden: Returned if any of the parents specified in the root resource path are restricted 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
GET	Gets the specified extension.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/queues/[{queue_id \| getByName{queue_identifier}}]/agent/{agent_id}/extension
Description	Provides access to the extension the specified agent relates to. Information This resource will not be available if the extension is not bound to a licensed/full user, or the agent is not in an enabled queue. Parameters: core_server_id: the id of the parent core server core_server_slug: the slug of the parent core server queue_id: the id of the parent queue queue_identifier: the identifier of the parent queue agent_id: the id of the agent Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no queue with the given id or identifier exists 404 Not Found: Returned if no agent with the given id exists 403 Forbidden: Returned if the parent queue is not enabled 403 Forbidden: Returned if the agent is not related to an extension that is bound to a full user
GET	Gets the extension the specified agent relates to.

Sub Resource Paths

Paths used to access the child resources of this resource.

{instance_resource_path}/agents
Description	Provides access to the agents related to the specified extension. See Agents. Information This resource will not be available if the extension is not bound to a licensed/full user. Excludes any agents that are not in an enabled queue. 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
GET	Gets all the agents related to the specified extension.

{instance_resource_path}/callSegments
Description	Provides access to the call segments for the specified extension. See Call Segments. Information This resource 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
GET	Gets all the call segments for the specified extension.

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
422 Unprocessable Entity: Returned if no destination number value was provided

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

Extensions

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