Send OTP Endpoint
==============

+---------------------------------------------------------------------+-------------------------------------------------+---------------+
| URL                                                                 | Required Values                                 | HTTP Methods  |
+=====================================================================+=================================================+===============+
| https://app.tingting.io/api/v1/auths/send/otp/                      | number, message, sms_send_options, company_name |     POST      |
+---------------------------------------------------------------------+-------------------------------------------------+---------------+

By utilizing this endpoint, you can send OTPs to users by specifying the recipient’s phone number as a string, along with 
the message containing the OTP and the desired delivery method - either through voice or text through the sms_send_option attribute. 
The OTP can be integrated in the message by passing it inside curly braces of the messages attribute.

For Example,

.. code-block:: json

    {
        "message" : "Hi Your OTP is {otp}"
    }


In addition, you have the flexibility to choose between sending your own OTP or generating it automatically through the OTP options attribute. The available options 
are personnel and generated. If you choose personnel, you’ll need to provide the OTP yourself. On the other hand, if you select generated, the OTP will be auto-generated. 
In the generated scenario, you can specify the length via the otp_length for the auto-generated OTP. If nothing is provided, by default a generated OTP will be provided.
If sms_send_options is chosen as voice then voice_input should be provided.

Sample Input For Customized OTP

.. code-block:: json

    {
        "number": "9851023212",
        "message": "Hi your OTP is {otp}",
        "sms_send_options": "text",
        "otp_options": "personnel",
        "otp": "12345",
        "company_name": "prixa"
    }


Sample Input For Auto-Generated OTP

.. code-block:: json

    {
        "number": "9851023212",
        "message": "Hi your OTP is {otp}",
        "sms_send_options": "voice",
        "voice_input": "np_rija",
        "otp_options": "personnel",
        "otp": "12345",
        "company_name": "prixa"
    }

The details of the sent OTP is shown.

Sample Output for text:

.. code-block:: json

    {
        "status": 200,
        "success": true,
        "message": "OTP Sent Successfully.",
        "errors": [],
        "data": {
            "details": {
                "number": "9861489014",
                "otp_options": "personnel",
                "message": "हेल्लो नमस्ते",
                "otp": "564546",
                "sms_send_options": "text",
                "credits_used": 1,
                "remaining_sms_credits": 62,
                "remaining_phone_credits": 127,
                "company_name": "prixa"
            }
        }
    }


Sample Output for voice:

.. code-block:: json

    {
    "status": 200,
    "success": true,
    "message": "OTP Call Initiated Successfully.",
    "errors": [],
    "data": {
        "details": {
            "number": "9861489014",
            "otp_options": "personnel",
            "message": "हेल्लो नमस्ते",
            "otp": "564546",
            "sms_send_options": "voice",
            "credits_used": 1,
            "remaining_sms_credits": 63,
            "remaining_phone_credits": 127,
            "voice_input": "np_rija",
            "length_factor": 1.0,
            "company_name": "prixa"
        }
    }
}