Extensions

Version 28.1 by michaely on 2015/07/09 17:02

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.

Description

The live extension REST resource allows access to information about the status of a specific extension in the system. This resource also provides actions for originating calls, and enabling/disabling Do Not Disturb on an extension.

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

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.

Root Resource Path

communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/extensions

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 access 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.

Resource Paths

The extension resource can be accessed from several different parent resources. The following resource paths have been organized by the parent path used to access the resource.

Core Server Parent

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions
Description	Accesses the state of all extensions, in a core server. Information The returned result will exclude 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 the state of all extensions, in a specified core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions/{extension_id}
Description	Accesses the state of a specific extension, in a core server, by extension id. Information This resource will not be available if the extension is 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 extension_id: the id of the extension to access Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no extension exists with the give id, in the specified core server 403 Forbidden: Returned if the extension is not bound to a licensed/full user
GET	Gets the state of a specific extension, in a core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions/getByName/{extension_number}
Description	Accesses the state of a specific extension, in a core server, by extension number. Information This resource will not be available if the extension is 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 extension_number: the extension number of the extension to access Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no extension exists with the give extension number, in the specified core server 403 Forbidden: Returned if if the extension is not bound to a licensed/full user
GET	Gets the state of a specific extension, in a core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions/[{extension_id} getByName/{extension_number}]/agents
Description	Access the sub/child resource for the queue agents bound to the specified extension. Information This resource will not be available if the extension is 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 extension_id: the id of the extension to access extension_number: the extension number of the parent extension Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no extension exists with the give id or extension number, in the specified core server. 403 Forbidden: if the extension is not bound to a licensed/full user

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/extensions/[{extension_id} getByName/{extension_number}]/callSegments
Description	Access the sub/child resource for the call segments bound to the specified extension. Information This resource will not be available if the extension is 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 extension_id: the id of the extension to access extension_number: the extension number of the parent extension Errors: 404 Not Found: Returned if no core server with the given id or slug exists 404 Not Found: Returned if no extension exists with the given id or extension number, in the specified core server. 403 Forbidden: if the extension is not bound to a licensed/full user

User Parent

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions
Description	Accesses the state of all extensions bound to a specific user, in a core server. Information The returned result will exclude 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 in the specified core server 403 Forbidden: if the extension is not bound to a licensed/full user
GET	Gets the state of all extensions bound to a specific user.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions/{extension_id}
Description	Accesses the state of a specific extension, bound to a user, by extension id. Information This resource will not be available if the extension is 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 extension_id: the id of the extension to access 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 in the specified core server 404 Not Found: Returned if no extension exists with the given id, that is bound to the specified user. 403 Forbidden: Returned if the extension is not bound to a licensed/full user
GET	Gets the state of a specific extension bound to a user.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions/getByName/{extension_number}
Description	Accesses the state of a specific extension, bound to a user, by extension number. Information This resource will not be available if the extension is 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 extension_id: the id of the parent extension extension_number: the extension number of the parent extension 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 in the specified core server 404 Not Found: Returned if no extension exists with the given id, that is bound to the specified user. 403 Forbidden: Returned if the extension is not bound to a licensed/full user
GET	Gets the state of a specific extension bound to a user.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions/[{extension_id} getByName/{extension_number}]/agents
Description	Access the sub/child resource for the queue agents bound to the specified extension, that is bound to the specified user. Information This resource will not be available if the extension is 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 extension_id: the id of the parent extension extension_number: the extension number of the parent extension 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 in the specified core server 404 Not Found: Returned if no extension exists with the given id or extension number, that is bound to the specified user. 403 Forbidden: Returned if the extension is not bound to a licensed/full user

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions/[{extension_id} getByName/{extension_number}]/callSegments
Description	Access the sub/child resource for the call segments bound to the specified extension, that is bound to the specified user. Information This resource will not be available if the extension is 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 extension_id: the id of the parent extension extension_number: the extension number of the parent extension 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 in the specified core server 404 Not Found: Returned if no extension exists with the given id or extension number, that is bound to the specified user. 403 Forbidden: Returned if the extension is not bound to a licensed/full user

Action Paths

communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/status/set

Description

Updates the status of a user.

This action will not be available if the user is not licensed/full, or no license is installed on the core server.

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 user to update status on
user_name: the username of the user to update status on

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 in the specified core server
422 Unprocessable Entity: Returned if no JSON name property is given
422 Unprocessable Entity: Returned if no JSON type property is given
422 Unprocessable Entity: Returned if the JSON type property value is not valid
422 Unprocessable Entity: Returned if the JSON returnTime property value is to0 large, or is a non numerical value.
403 Forbidden: Returned if the user is not licensed/full, or no license is installed on the core server.

JSON

{
"name": "Went back in time",
"type": "away",
"note": "Tell Doc Brown",
"returnTime": 499132800
}

Properties:

Property	Type	Description
name	String	The status name.
type	String	The status type. Determines the icon used for the status. See Status Types above.
note	String	The note for the status.
returnTime	Long	The time the user is returning, or -1 for no return time. Represented as a unix timestamp, in milliseconds.

POST

Updates the status of the user.

Curl Examples

Get the status of a user in a specific core server

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

Set the status of a user in a specific core server

curl --user manager:manag3rpa55word -i -H "Content-Type: application/json" -X POST -d '{"name" : "Went back in time", "type" : "away", "note" : "Tell Doc Brown", "returnTime" : 499132800}' http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/status/set