RapidSMS Relay

Calls out to an application implemented in RapidSMS.

RapidSMS Relay

class vumi.application.rapidsms_relay.RapidSMSRelayConfig(config_data, static=False)

RapidSMS relay configuration.

Configuration options:

Parameters:
  • amqp_prefetch_count (int) – The number of messages fetched concurrently from each AMQP queue by each worker instance.
  • transport_name (str) – The name this application instance will use to create its queues.
  • send_to (dict) – ‘send_to’ configuration dict.
  • web_path (str) – Path to listen for outbound messages from RapidSMS on.
  • web_port (int) – Port to listen for outbound messages from RapidSMS on.
  • redis_manager (dict) – Redis manager configuration (only required if allow_replies is true)
  • allow_replies (bool) – Whether to support replies via the in_reply_to argument from RapidSMS.
  • vumi_username (str) – Username required when calling web_path (default: no authentication)
  • vumi_password (str) – Password required when calling web_path
  • vumi_auth_method (str) – Authentication method required when calling web_path.The ‘basic’ method is currently the only available method
  • vumi_reply_timeout (int) – Number of seconds to keep original messages in redis so that replies may be sent via in_reply_to.
  • allowed_endpoints (list) – List of allowed endpoints to send from.
  • rapidsms_url (URL) – URL of the rapidsms http backend.
  • rapidsms_username (str) – Username to use for the rapidsms_url (default: no authentication)
  • rapidsms_password (str) – Password to use for the rapidsms_url
  • rapidsms_auth_method (str) – Authentication method to use with rapidsms_url. The ‘basic’ method is currently the only available method.
  • rapidsms_http_method (str) – HTTP request method to use for the rapidsms_url
class vumi.application.rapidsms_relay.RapidSMSRelay(options, config=None)

Application that relays messages to RapidSMS.