onadata.apps.sms_support.providers package¶

Submodules¶

onadata.apps.sms_support.providers.smssync module¶

Ushaidi’s SMSSync gateway

Supports Receiving and replying SMS from/to the SMSSync App.

See: http://smssync.ushahidi.com/doc

onadata.apps.sms_support.providers.smssync.autodoc(url_root, username, id_string)¶: Returns SMSSync integration documentation.

onadata.apps.sms_support.providers.smssync.get_response(data)¶: Return a JSON formatted HttpResponse based on the data provided.

onadata.apps.sms_support.providers.smssync.import_submission(request, username)¶: Proxy to import_submission_for_form with None as id_string

onadata.apps.sms_support.providers.smssync.import_submission_for_form(request, username, id_string)¶: Retrieve and process submission from SMSSync Request

onadata.apps.sms_support.providers.smssync.process_message_for_smssync(username, sms_identity, sms_text, sms_time, id_string)¶: Process a text instance and return in SMSSync expected format

onadata.apps.sms_support.providers.telerivet module¶

Telerivet WebHook gateway

Supports Receiving and replying SMS from/to Telerivet Service

See: http://telerivet.com/help/api/webhook/receiving

onadata.apps.sms_support.providers.telerivet.autodoc(url_root, username, id_string)¶: Returns Telerivet integration documentation.

onadata.apps.sms_support.providers.telerivet.get_response(data)¶: Return a JSON formatted HttpResponse based on the data provided.

onadata.apps.sms_support.providers.telerivet.import_submission(request, username)¶: Proxy to import_submission_for_form with None as id_string

onadata.apps.sms_support.providers.telerivet.import_submission_for_form(request, username, id_string)¶: Retrieve and process submission from SMSSync Request

onadata.apps.sms_support.providers.telerivet.process_message_for_telerivet(username, sms_identity, sms_text, sms_time, id_string)¶: Process a text instance and return in SMSSync expected format

onadata.apps.sms_support.providers.textit module¶

Nyaruka’s TextIt gateway

Supports Receiving and sending reply SMS from/to the TextIt App.

See: https://textit.in/api/v1/webhook/

onadata.apps.sms_support.providers.textit.autodoc(url_root, username, id_string)¶: Returns the documentation string for the provider.

onadata.apps.sms_support.providers.textit.get_response(data)¶: Sends SMS data to textit via send_sms_via_textit() function.

onadata.apps.sms_support.providers.textit.import_submission(request, username)¶: Proxy to import_submission_for_form with None as id_string

onadata.apps.sms_support.providers.textit.import_submission_for_form(request, username, id_string)¶: Retrieve and process submission from SMSSync Request

onadata.apps.sms_support.providers.textit.process_message_for_textit(username, sms_identity, sms_text, sms_time, id_string, payload=None)¶: Process a text instance and return in SMSSync expected format

onadata.apps.sms_support.providers.textit.send_sms_via_textit(payload)¶: Returns the JsonResponse of the SMS JSOn payload for text it.

onadata.apps.sms_support.providers.twilio module¶

Twilio SMS gateway

Supports Receiving and replying SMS from/to Twilio. URL must be set to POST method in Twilio.

See: http://www.twilio.com/docs/api/twiml/sms/twilio_request: http://www.twilio.com/docs/api/twiml/sms/your_response

onadata.apps.sms_support.providers.twilio.autodoc(url_root, username, id_string)¶: Returns Twilio integration documentation.

onadata.apps.sms_support.providers.twilio.get_response(data)¶: Return an XML formatted HttpResponse based on the data provided.

onadata.apps.sms_support.providers.twilio.import_submission(request, username)¶: Proxy to import_submission_for_form with None as id_string

onadata.apps.sms_support.providers.twilio.import_submission_for_form(request, username, id_string)¶: Retrieve and process submission from SMSSync Request

onadata.apps.sms_support.providers.twilio.process_message_for_twilio(username, sms_identity, sms_text, sms_time, id_string)¶: Process a text instance and return in SMSSync expected format

Module contents¶

sms_support.providers

onadata.apps.sms_support.providers.import_submission(request, username, service)¶: Proxy to the service’s import_submission view

onadata.apps.sms_support.providers.import_submission_for_form(request, username, id_string, service)¶: Proxy to the service’s import_submission_for_form view

onadata.apps.sms_support.providers.providers_doc(url_root, username, id_string)¶

onadata.apps.sms_support.providers.unknown_service(request, username=None, id_string=None)¶: 400 view for request with unknown service name