Status

Version 10.1 by michaely on 2015/07/09 14:25

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 status REST resource allows access to information about the status of a specific user in the system. This resource also provides an action to update the status of a user.

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}]/users/[{user_id} | getByName/{username}]/status

JSON Representation

{
"id": "99c6c017-7c86-4d78-89ca-dbc1267ffe76",
"configurationId": "215734e0-383d-11e2-81c1-0800200c9a66",
"name": "Available",
"type": "available",
"note": "",
"returnTime": -1,
"userCreated": false
}

Property	Type	Description
id	String	The id of the user status.
configurationId	String	The id of the configuration object that represents the user status.
name	String	The status name.
type	String	The status type. Determines the icon used for the status. See Status Types below.
note	String	The note set for the status.
returnTime	Long	The time the user has set to return, or -1 if no return time has been set. Represented as a unix timestamp, in milliseconds.
userCreated	Boolean	True, if the status is a custom status set by the user; false, if the status is a pre-configured status.

Status Types

The following is a list of accepted status types. These types will be used in the JSON representation of the status, and in the set action when changing the status.

The current status type set on a user does not effect call flow or any other actions in the panel. The status is simply used for informational purposes.

available
unavailable
away
xa
dnd
chat
altblue
altgreen
altpink
altpurple
altred

Resource Paths

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users
Description	Accesses the state of all users in a core server. Parameters: core_server_id: the id of the core server to get the user from core_server_slug: the slug of the core server to get the user from Errors: 404 Not Found: Returned if no core server with the given id or slug exists
GET	Gets the state of all users in a core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/{user_id}
Description	Accesses the state of a specific user in a core server, by user id. Parameters: core_server_id: the id of the core server to get the user from core_server_slug: the slug of the core server to get the user from user_id: the id of the user 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 exists in the specified core server
GET	Gets the state of a specific user in a core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/getByName/{username}
Description	Accesses the state of a specific user in a core server, by username. Parameters: core_server_id: the id of the core server to get the user from core_server_slug: the slug of the core server to get the user from user_name: the username of the user 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 username exists in the specified core server
GET	Gets the state of a specific user in a core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/logins
Description	Access the sub/child resource for the active logins of specific 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 user_name: 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

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/status
Description	Access the sub/child resource for the status of a specific 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 user_name: 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

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users/[{user_id} \| getByName/{username}]/extensions
Description	Access the sub/child resource for the extensions bound to a specific 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 user_name: 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

Curl Examples

Get the state of all users 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

Get the state of a specific 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/4aff6119-54e8-4884-bff6-f76c7dddf74b