Create an OTP message request in live or sandbox execution mode

post

https://api.wevlix.com/v1/otp/send

Creates a WhatsApp OTP message request. Only to is required. If both otpMode and code are omitted, Wevlix generates the six-digit code. Supplying code without otpMode is valid and infers provided mode. In live mode, Wevlix selects an approved, sendable AUTHENTICATION template from the project WhatsApp account: it prefers the requested locale, then a locale prefix, then the earliest eligible template. Newly connected verified businesses with no existing templates normally receive the wevlix_otp starter in English and Arabic, but this endpoint does not guarantee that template name. Generated and provided modes use the same selected template. In sandbox mode or with a development key, delivery is simulated without an upstream call or billing. Use clientMessageId for retry-safe idempotency.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Start with the minimal request. Add optional fields only when your integration needs them.

string

required

Recipient phone number in E.164 format: +{country_code}{subscriber_number}.

countryIso2

string

Optional validation hint. Wevlix derives the billing country from the E.164 recipient and rejects a mismatch.

clientMessageId

string

otpMode

string

enum

Defaults to generated

Optional mode override. Omit it to let Wevlix generate the OTP, unless code is present, in which case provided mode is inferred. Use generated when Wevlix creates the OTP or provided when your backend supplies code.

Allowed:

code

string

Optional six-digit OTP supplied by your backend. Providing code without otpMode is valid and automatically selects provided mode. It is required when otpMode is provided and forbidden when otpMode is generated.

locale

string

international

boolean

Use international authentication base rate when available.

Responses

400

The payload is invalid. Common conflicts are otpMode=provided without code, otpMode=generated with code, or a code that is not exactly six digits.

401

Missing or invalid API key.

403

OTP sending is not allowed for this API key, the development-key phone allow-list, project WABA state, or project balance.

200OTP request accepted. Live sends are queued for WhatsApp delivery; sandbox/development sends are queued for simulation.