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

{{baseUrl}}api/v1/messaging/otp

Headers

Parameter

Type

Description

AppId

string

you would need to create an app to get your app ID

Authorization

string

public secret key e.g prod_sk_1T1eSavlZxy02OT3OWlvbxK4G

Body Parameters

Parameter Type Description
sender_id * string registered Sender ID required
destination * string phone number of recipient required
channel * string can be either whatsapp, sms, or voice required
expiry * integer number of minutes before token becomes Invalid. Default is 10 optional
length integer length of token(4 to 10 characters), default is 6 characters optional
priority boolean indicate if you want to send in priority mode. Default is false optional
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 voice. You can choose to set it however way you want in the channel parameter.

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

Response Sample

{
  "entity": {
    "reference_id": "edd37ab5-48ec-4481-8cf9-ba5chu7c41f7",
    "destination": "2348012345678",
    "status": "SMS sent successfully"
  }
}

Did this page help you?