API Reference

General functions:

sendsms.api.get_connection(path=None, fail_silently=False, **kwargs)

Load an sms backend and return an instance of it.

Parameters:
  • path (string) – backend python path. Default: sendsms.backends.console.SmsBackend
  • fail_silently (bool) – Flag to not throw exceptions on error. Default: False
Returns:

backend class instance.

Return type:

BaseSmsBackend subclass

sendsms.api.send_mass_sms(datatuple, fail_silently=False, auth_user=None, auth_password=None, connection=None)

Given a datatuple of (message, from_phone, to, flash), sends each message to each recipient list.

Returns:the number of SMSs sent.
sendsms.api.send_sms(body, from_phone, to, flash=False, fail_silently=False, auth_user=None, auth_password=None, connection=None)

Easy wrapper for send a single SMS to a recipient list.

Returns:the number of SMSs sent.