API Documentation

Send Whatsapp OTP

This method helps you to generate and send Whatsapp message containing one-time password to destination number

Callback Description

When you want to use callback_url payload you only need to put for example

your-callback-url.com/callback

Example callback that we'll send

your-callback-url.com/callback?session_id=d0f5fb5c-2d50-4d3f-aea7-20018ab15806&status=1
PayloadDescription
session_idID of the specific message
statusLatest status of the request

Callback Status Description

StatusDescriptionCondition
0RequestedOTP has been requested. This status will be charged.
1SentOTP has been sent to Whatsapp server. This status will be charged.
2DeliveredOTP has been delivered to destination number. This status will be charged.
3ReadOTP has been read by user. This status will be charged.
4VerifiedOTP has been verified by user. This status will be charged.
5UnverifiedOTP has reached time limit. This status will be charged.
6FailedWhatsapp cannot send OTP to destination number. This status will be charged.
7Request ErrorVerihubs cannot reach WhatsApp
10Tier Limit ExceededExceeding channel tier limit
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Destination Phone Number. You need to include international prefix number.

string

Optional. Code generated by client.

string

This value is a category. You can verify OTP based on the same challenge.

string

Optional. Expiration time for verify OTP in seconds.

string
required

Language code to send in a different language. Use this optional payload to switch template easily if you have multiple language template with the same name. (need to be approved first by Facebook)

string

Optional. Name of the template that will be use (need to be approved first by Facebook) If you're going to use a template with different language than your original template on the setting, you must include 'lang_code' payload too.

string

Optional. Length of the OTP, do not send alongside self generated OTP code payload (payload otp)

string

Optional. This URL will be called by the server when the desired event will occur.

Headers
string
required
string
required
Responses

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json