res_ari

ari.conf

[general]

General configuration settings

• enabled - Enable/disable the ARIAsterisk REST Interface. A modern asynchronous API exposing channels, bridges, and endpoints over HTTP and WebSocket for building custom call applications. module

  Note

  ARI uses Asterisk's HTTP server, which must also be enabled in http.conf.

• websocket_write_timeout - The timeout (in milliseconds) to set on WebSocket connections.

• pretty - Responses from ARI are formatted to be human readable
• auth_realm - Realm to use for authentication. Defaults to Asterisk REST Interface.
• allowed_origins - Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins.
• channelvars - Comma separated list of channelA single call leg passing through Asterisk. Channels represent connections to endpoints and are what dialplan applications act on. variables to display in channel json.

[user]

Per-user configuration settings

• type - Define this configuration section as a user.
• read_only - When set to yes, user is only authorized for read-only requests
• password - Crypted or plaintext password (see password_format)
• password_format - 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
• acl - List of IP ACL section names in acl.conf
• deny - List of IP addresses to deny access from
• permit - List of IP addresses to permit access from

[outbound_websocket]

Outbound websocket configuration

• type - Must be "outbound_websocket".
• websocket_client_id - The ID of a connection defined in websocket_client.conf.
• apps - Comma separated list of stasis applications that will use this websocket.
• local_ari_user - The local ARI user to act as.
• subscribe_all - Subscribe applications to all event