Send OTP template message

Send a one-time code with your approved WhatsApp authentication template. You send a flat body: the template (event), the recipient and the code. The gateway places the code where an authentication template expects it: in the message body and in the copy-code button.

You generate the code and check it yourself. To have TextPeak generate and verify the code, use OTP Auth Request instead.

One request sends one message. sender is the WhatsApp Business number the template is sent from.

Response. HTTP 200 with a task_id and one entry per message. status is false when any message failed: failed entries come first and carry error (hex code) and details; accepted entries carry message_uuid (and conversation_uuid on two-way channels). Match entries by internal_id. Final delivery status is sent asynchronously to your configured webhook.

Authentication: channel token in the Authorization header (see Authentication in the API Overview).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

WhatsApp Business sender phone number. When left out, the channel's sender is used.

string
required

Your approved WhatsApp authentication template, by its eventKey on the channel.

string
required

Recipient phone number in international format, as a string. +, spaces, - and parentheses are removed before validation. Not needed when conversation_uuid or contact.phone identifies the recipient.

string
required

The one-time code to send, as a string (keep leading zeros). You generate it; it fills the template body and its copy-code button.

Your identifier for the message. Echoed back in the response and in delivery webhooks (internal_id). Up to 36 characters are kept; longer values are cut. Not checked for uniqueness.

Responses

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