Asterisk Default Extension User

Last modified by ryanp 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.1+.

Description

The default extension user REST resource allows access to the user who has the parent extension set as their default extension. This resource allows you to set which user the extension is the default extension for.

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/config/asterisk/{serverId}/extensions/{extensionId}/defaultExtensionUser

JSON Representation

{
"id": "56cf70a3-1ee0-4b09-8f40-297430eeeddf",
"username": "4224",
"password": "e5e9fa1ba31ecd1ae84f75caaa474f3a663f05f4",
"enabled": true,
"full": true,
"displayName": "Steve S",
"lastPasswordChangedAt": null,
"permissionDisplayName": "Steve S",
"permissionId": "56cf70a3-1ee0-4b09-8f40-297430eeeddf"
}

Property	Type	Description
id	String	Configuration id of the user.
username	String	Username of the user.
password	String	SHA-1 hash of the user's password.
enabled	Boolean	Flag specifying if the user is enabled.
full	Boolean	Flag specifying if the user is a full or lite user.
displayName	String	The display name for the user.
lastPasswordChangedAt	Long	The last time the user changed their password from the client interface. Represented as a Unix timestamp in milliseconds. Can be null.
permissionDisplayName	String	Display name of the user in the permission system.
permissionId	String	Permission id of the user.

Resource Paths

communication_manager/rest/config/asterisk/{serverId}/extensions/{extensionId}/defaultExtensionUser
Description	Accesses the user the extension is set as a default for.
GET	Gets the user the extension is set as a default for. Errors: 404 'The extension's user does not have a default extension set': The extension does not have a default user set. 404 'The extension is not bound to a user': The extension is not currently bound to a user. The extension must be bound to the user before you can set it as the default extension of the user. 404 'This extension is not a default extension': The extension is not currently bound to any user.
PUT	Sets the extension as the default extension for the given user.

Curl Examples

Gets the user the current extension is set as a default for

curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extensions/56cf70a3-1ee0-4b09-8f40-297430eeeddf/defaultExtensionUser

Set the extension as the default extension for the given user

curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X PUT -d '{"id":"ed38fe4d-13ad-4fd0-be25-d3404c421370","username":"4224","password":"60b6e3843f2b26d3a24c27c4f3f071861c2f14e4","enabled":true,"full":false,"displayName":"Michael Y (desk)","lastPasswordChangedAt":null,"permissionDisplayName":"Michael Y (desk)","permissionId":"ed38fe4d-13ad-4fd0-be25-d3404c421370"}' http://localhost:58080/communication_manager/rest/config/asterisk/ee828da8-5ee6-412d-82ac-1273f598659d/extension/56cf70a3-1ee0-4b09-8f40-297430eeeddf/defaultExtensionUser