Asterisk REST Interface Users Module User Guide
- Nathaniel Halbrooks
Introduction
The Asterisk REST Interface User module is used to create users for the Asterisk Rest Interface.
This module requires an Asterisk version greater than 12.
This module must be enabled under Advanced Settings
Logging In
Log in to the FreePBX UI.
On the top menu click Settings
In the drop down click Asterisk REST Interface User
First Run
The module may be disabled under advanced settings. To enable
On the top menu click Settings
In the drop down click Advanced Settings
If not already enabled, set "Display Read Only Settings" and "Override Readonly Settings" to "Yes" and submit the page.
On the same page, locate the section "Asterisk REST Interface"
Enable the Asterisk REST Interface
Determines whether the Asterisk ARI is enabled or not
ARI Username
The username for the PBX generated ARI user used for internal purposes. This should be a randomly generated string of 15 to 30 characters
ARI Password
The password for the PBX generated ARI user used for internal purposes. This should be a randomly generated string of 30+ characters
Pretty Print JSON Responses
Should the JSON responses be made "Pretty"
Web Socket Write Timeout
The timeout (in milliseconds) to set on WebSocket connections.
Adding User
If you need an Asterisk ARI user account for external purposes, you can set one up directly in the PBX GUI. To start, browse to Settings, Asterisk REST Interface Users and click the "Add User" button
REST Interface User Name
User name for the ARI user.
REST Interface User Password
Password for REST API calls
Password Type
Crypt
Store the password Crypt(3) encrypted
Plain Text
Store the password in Plain Text
Read Only
Should this user be able to read only or should they have write access.