Page History

...

• Log in to the FreePBX UI.
• On the top menu click Settings
• In the drop down click Asterisk REST Interface User

First Run

Image RemovedImage Added

The module may be disabled under advanced settings. To enable

• On the top menu click Settings
• In the drop down click Advanced Settings

Image Removed

• If not already enabled, set "Display Read Only Settings" and "Override Readonly Settings" to "Yes" and submit the page.

Image Added

• On the same page, locate the section "Asterisk REST Interface"

Image Added

Enable the Asterisk REST Interface

Whether Determines whether the Asterisk ARI is enabled or not the Asterisk REST interface should be enabled.

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"

Adding User

Image Removed

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

Image Added

REST Interface User Name

User name for REST API callsthe ARI user. 

REST Interface User Password

...