res_xmpp: XMPP Messaging¶
This configuration documentation is for functionality provided by res_xmpp.
Configuration File: xmpp.conf¶
[global]: Global configuration settings¶
Since¶
12.0.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| auth_policy | Custom | accept | false | Whether to automatically accept or deny users' subscription requests | 11.0.0 |
| autoprune | Custom | no | false | Auto-remove users from buddy list. | 11.0.0 |
| autoregister | Custom | yes | false | Auto-register users from buddy list | 11.0.0 |
| collection_nodes | Custom | no | false | Enable support for XEP-0248 for use with distributed device state | 11.0.0 |
| debug | Custom | no | false | Enable/disable XMPP message debugging | 11.0.0 |
| pubsub_autocreate | Custom | no | false | Whether or not the PubSub server supports/is using auto-create for nodes | 11.0.0 |
Configuration Option Descriptions¶
autoprune¶
Since: 11.0.0
Auto-remove users from buddy list. Depending on the setup (e.g., using your personal Gtalk account for a test) this could cause loss of the contact list.
[client]: Configuration options for an XMPP client¶
Since¶
12.0.0
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| auth_policy | Custom | false | Whether to automatically accept or deny users' subscription requests | 11.18.0, 13.4.0 | |
| autoprune | Custom | false | Auto-remove users from buddy list. | 11.18.0, 13.4.0 | |
| autoregister | Custom | false | Auto-register users bfrom buddy list | 11.18.0, 13.4.0 | |
| buddy | Custom | false | Manual addition of buddy to list | 11.0.0 | |
| context | String | default | false | Dialplan context to send incoming messages to | 11.0.0 |
| debug | Custom | no | false | Enable debugging | 11.0.0 |
| distribute_events | Custom | no | false | Whether or not to distribute events using this connection | 11.0.0 |
| forceoldssl | Custom | no | false | Force the use of old-style SSL for the connection | 11.0.0 |
| keepalive | Custom | yes | false | If enabled, periodically send an XMPP message from this client with an empty message | 11.0.0 |
| oauth_clientid | String | false | Google OAuth 2.0 application's client id | 13.18.0, 14.7.0, 15.1.0 | |
| oauth_secret | String | false | Google OAuth 2.0 application's secret | 13.18.0, 14.7.0, 15.1.0 | |
| port | Unsigned Integer | 5222 | false | XMPP server port | 11.0.0 |
| priority | Unsigned Integer | 1 | false | XMPP resource priority | 11.0.0 |
| pubsub_node | String | false | Node for publishing events via PubSub | 11.0.0 | |
| refresh_token | String | false | Google OAuth 2.0 refresh token | 13.18.0, 14.7.0, 15.1.0 | |
| secret | String | false | XMPP password | 11.0.0 | |
| sendtodialplan | Custom | no | false | Send incoming messages into the dialplan | 11.0.0 |
| serverhost | String | false | Route to server, e.g. talk.google.com | 11.0.0 | |
| status | Custom | available | false | Default XMPP status for the client | 11.0.0 |
| statusmessage | String | Online and Available | false | Custom status message | 11.0.0 |
| timeout | Unsigned Integer | 5 | false | Timeout in seconds to hold incoming messages | 11.0.0 |
| type | Custom | client | false | Connection is either a client or a component | 11.0.0 |
| username | String | false | XMPP username with optional resource | 11.0.0 | |
| usesasl | Custom | yes | false | Whether to use SASL for the connection or not | 11.0.0 |
| usetls | Custom | yes | false | Whether to use TLS for the connection or not | 11.0.0 |
Configuration Option Descriptions¶
autoprune¶
Since: 11.18.0, 13.4.0
Auto-remove users from buddy list. Depending on the setup (e.g., using your personal Gtalk account for a test) this could cause loss of the contact list.
buddy¶
Since: 11.0.0
Manual addition of buddy to the buddy list. For distributed events, these buddies are automatically added in the whitelist as 'owners' of the node(s).
status¶
Since: 11.0.0
Can be one of the following XMPP statuses:
-
chat -
available -
away -
xaway -
dnd
timeout¶
Since: 11.0.0
Timeout (in seconds) on the message stack. Messages stored longer than this value will be deleted by Asterisk. This option applies to incoming messages only which are intended to be processed by the 'JABBER_RECEIVE' dialplan function.
Generated Version¶
This documentation was generated from Asterisk branch 20 using version GIT