Send OTP

Deliver OTPs to your users via multiple channels such as Whatsapp, voice, and SMS.

📘

NOTE

You would need to register a sender ID with the endpoint mentioned below. All messages sent before then will be delivered with the default sender ID

Request

HTTP[POST]

{{baseUrl}}/messaging/otp/

Body Parameters

Parameters	Type	Description	Mandatory
reference	String	For tracking messages	Optional
sender	String	Registered Sender	Required
destination	String	Phone number of recipient	Required
length	Integer	Length of token(4 to 10 characters), default is 6 characters	Required
expiry	Integer	Number of minutes before token becomes Invalid. Default is 12	Optional
channel	String	Can be either whatsapp, sms, or voice	required
otp	Integer	Length of token should be between 4-10 digits which is optional	Optional

📘

NOTE

There is the priority feature. You can automatically resend messages via any of the channels if one doesn't get delivered. If the priority is set to true, the default setup is SMS, WhatsApp, and then the voice. You can choose to set it however way you want in the channel parameter.

You can decide to use the OTP parameter to send OTP, instead of the generated one.

Response Sample

Response

{
    "status": true,
    "message": "OTP Sent Successfully To 2348149983395",
    "data": {
        "sender": "Wallx",
        "reference": "DC-DC_d3Eb9Hypl1tuaRLZ",
        "destination": "2348149983395",
        "otp": "926349",
        "channel": "whatsapp",
        "expires_at": "2022-03-15T12:05:41.388713"
    }
}