-Easily send SMS messages through a web gateway from django.
+Easily send SMS messages through a web gateway from django.
+ * Install the package into your project's virtual environment:
+ ``pip install django-sms-gateway``
+ * Add ``sms`` to your project's ``settings.INSTALLED_APPS``.
+ * Run ``./manage.py migrate`` or ``./manage.py syncdb``
+There are three django models: ``sms.Message``, ``sms.Gateway``, and ``sms.Reply``.
+Before you are able to send any messages, you will need to configure at least one gateway. There is some sample data for some gateway providers. You can adapt one of these for your own purposes.
+Create a message, ready to be sent::
+ msg = Message.objects.create(
+ content="Test message",
+Note that you must provide at least these fields. ``recipient_number`` must include the international prefix (or your gateway must be configured to add it). ``content`` should be ASCII, some gateways reject unicode. ``sender`` must be an ``auth.User``, but ``billee`` may be any object.
+This does not send the message::
+ <Message: [Unsent] Sent to 123456789 by matt at None >
+To send it, you need to provide a gateway::
+If your gateway supports it, you can have it hit your server whenever there are status updates on any message. You can use the included views, in your urlpatterns::
+ urlpatterns = patterns('',
+ (r'^sms/', include('sms.urls')),
+This would mean that you would need to enter something like::
+In your gateway's settings.
+The same applies for replies, if you have a 2-way gateway, but using ``/sms/reply_postback/`` instead.
+Reply callback functions
+When you send a message, you can store a ``reply_callback`` function in the object. This function will be called, with the reply object passed in as the parameter. The reply object has access to it's original message (as well as it could be matched).
+Currently, all sending happens in-process. There is a preliminary celery task, but it has not been extensively tested as yet.