Metadata-Version: 2.1
Name: django-message
Version: 1.3
Summary: A Django app for telecom system.
Home-page: http://127.0.0.1:8000/telecom/
Author: Prabhat Mishra
Author-email: mishraa.prabhat@gmail.com
License: BSD-3-Clause
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
License-File: LICENSE

========
Message
========

This is a Django app used in REST APIs to send SMS and OTP on the user's mobile
number and verify the number using OTP entered by the user. This app is using TWILIO
service to send SMS, So before using this app make sure you have **TWILIO** account.

You can refer to this link to know more about TWILIO.

`https://www.twilio.com/docs/sms/quickstart/python` _

Quick start
-----------

1. Add "telecom" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'telecom',

    ]

2. Add these attribute to your setting like this::

    TWILIO_ACCOUNT_SID = 'set your ACCOUNT_SID'
    TWILIO_SERVICE_SID = 'set your SERVICE_SID'
    TWILIO_AUTH_TOKEN = 'set your AUTH_TOKEN'
    TWILIO_PHONE_NUMBER = 'set your PHONE_NUMBER'

3. Include the telecom URLconf in your project urls.py like this::
    path('telecom/', include('telecom.urls'), name='telecom'),

4. Send POST request http://127.0.0.1:8000/telecom/send-otp/ to send otp on user mobile::
    {

     "telecom": "mobile number" .. +919134454343
     "channel": "sms"

    }

5. Send POST request http://127.0.0.1:8000/telecom/verify-otp/ to verify OTP::
    {

     "telecom": "mobile number" .. +9134454343
     "code": "code" .. 343433
    
    }

6. Send POST request http://127.0.0.1:8000/telecom/send-sms/ to send sms::
    {

     "telecom": "mobile number" .. +919134454343
     "body": "message" .. Hi Zen!
    
    }
