res_ari: HTTP binding for the Stasis API¶
This configuration documentation is for functionality provided by res_ari.
Configuration File: ari.conf¶
[general]: General configuration settings¶
Since¶
12.0.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| allowed_origins | String | false | Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins. | 12.0.0 | |
| auth_realm | String | Asterisk REST Interface | false | Realm to use for authentication. Defaults to Asterisk REST Interface. | 12.0.0 |
| channelvars | String | false | Comma separated list of channel variables to display in channel json. | 14.2.0 | |
| enabled | Boolean | yes | false | Enable/disable the ARI module | 12.0.0 |
| pretty | Custom | no | false | Responses from ARI are formatted to be human readable | 12.0.0 |
| websocket_write_timeout | Integer | 100 | false | Write timeout (ms). | 11.11.0, 12.4.0 |
Configuration Option Descriptions¶
enabled¶
Since: 12.0.0
This option enables or disables the ARI module.
Note
ARI uses Asterisk's HTTP server, which must also be enabled in http.conf.
websocket_write_timeout¶
Since: 11.11.0, 12.4.0
The maximum number of milliseconds to wait for a write to the WebSocket to succeed. The WebSocket will be closed when the timeout is reached. For outgoing WebSocket connections, this sets the default timeout which can be overridden in websocket_client.conf.
Note
Success means the write request was accepted by the operating system and does not imply the payload was actually transmitted or received by the server.
[user]: Per-user configuration settings¶
Since¶
12.0.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| acl | Custom | false | List of IP ACL section names in acl.conf | 20.19.0, 22.9.0, 23.3.0 | |
| deny | Custom | false | List of IP addresses to deny access from | 20.19.0, 22.9.0, 23.3.0 | |
| password | String | false | Crypted or plaintext password (see password_format) | 13.30.0, 16.7.0, 17.1.0 | |
| password_format | Custom | plain | false | password_format may be set to plain (the default) or crypt. When set to crypt, crypt(3) is used to validate the password. A crypted password can be generated using mkpasswd -m sha-512. When set to plain, the password is in plaintext | 12.0.0 |
| permit | Custom | false | List of IP addresses to permit access from | 20.19.0, 22.9.0, 23.3.0 | |
| read_only | Boolean | no | false | When set to yes, user is only authorized for read-only requests | 13.30.0, 16.7.0, 17.1.0 |
| type | None | false | Define this configuration section as a user. | 13.30.0, 16.7.0, 17.1.0 |
Configuration Option Descriptions¶
acl¶
Since: 20.19.0, 22.9.0, 23.3.0
This matches sections configured in 'acl.conf'.
deny¶
Since: 20.19.0, 22.9.0, 23.3.0
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
permit¶
Since: 20.19.0, 22.9.0, 23.3.0
The value is a comma-delimited list of IP addresses. IP addresses may have a subnet mask appended. The subnet mask may be written in either CIDR or dotted-decimal notation. Separate the IP address and subnet mask with a slash ('/')
type¶
Since: 13.30.0, 16.7.0, 17.1.0
user- Configure this section as a user
[outbound_websocket]: Outbound websocket configuration¶
Since¶
20.15.0, 21.10.0, 22.5.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| apps | String | false | Comma separated list of stasis applications that will use this websocket. | 20.15.0, 21.10.0, 22.5.0 | |
| local_ari_user | String | false | The local ARI user to act as. | 20.15.0, 21.10.0, 22.5.0 | |
| subscribe_all | Boolean | no | false | Subscribe applications to all event | 20.15.0, 21.10.0, 22.5.0 |
| type | None | false | Must be "outbound_websocket". | 20.15.0, 21.10.0, 22.5.0 | |
| websocket_client_id | Custom | false | The ID of a connection defined in websocket_client.conf. | 20.15.0, 21.10.0, 22.5.0 |
Generated Version¶
This documentation was generated from Asterisk branch 23 using version GIT