res_websocket_client

Since 20.15.0 Module Configuration Found this useful? Upvote it. ×

Websocket Client Configuration

Last reviewed 2026-04-14

Description

websocket_client.conf

[websocket_client]

Websocket Client Configuration

  • type - Must be "websocket_client".
  • uri - Full URI to remote server.
  • protocols - Comma separated list of protocols acceptable to the server.
  • username - Server authentication username if required.
  • password - Server authentication password if required.
  • connection_type - Single persistent connection or per-call configuration.
  • connection_timeout - Connection timeout (ms).
  • reconnect_attempts - On failure, how many times should reconnection be attempted?
  • reconnect_interval - How often should reconnection be attempted (ms)?
  • tls_enabled - Enable TLS
  • ca_list_file - File containing the server's CA certificate. (optional)
  • ca_list_path - Path to a directory containing one or more hashed CA certificates. (optional)
  • cert_file - File containing a client certificate. (optional)
  • priv_key_file - File containing the client's private key. (optional)
  • verify_server_cert - If set to true, verify the server's certificate. (optional)
  • verify_server_hostname - If set to true, verify that the server's hostname matches the common name in it's certificate. (optional)
User Notes

Know a tip or gotcha for this topic? Share it below and help others.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Moderated before publishing. Email never shown.