Request - Code
This endpoint allows you to request a one-time password (OTP) code for global use across multiple channels. The GLOBAL designation means the system will intelligently randomize the channel used to send or receive messages between your system and the user, optimizing for availability and delivery success. This endpoint generates a secure One-Time Password (OTP) with highly customizable validation settings, including options for code length, character types (letters and/or numbers), case sensitivity, and expiration time. This flexibility makes it suitable for various security requirements across different applications. The global nature of this endpoint is particularly valuable for businesses operating across multiple regions or using multiple WhatsApp channels, as it ensures reliable OTP delivery regardless of individual channel limitations or regional restrictions.
Overview
This endpoint allows you to request a one-time password (OTP) code for global use. GLOBAL means the system will randomize the channel to send or receive the message from or to the user. This endpoint generates a One-Time Password (OTP) with customizable validation settings.
Request Parameters
The contact ID to send the OTP code to. Format: xxx@c.us
Length of the OTP code. Maximum value is 6.
Whether to include letters in the OTP code.
Whether to include numbers in the OTP code.
Whether to use uppercase letters for the OTP code.
Application name that will be displayed to the user.
Expiration time in seconds. For example, 1800 seconds (30 minutes).
Response
Indicates whether the request was successful.
A message describing the result of the operation.
Error Codes
Authorization Exception - Occurs when the request is not properly authorized.
Validation Exception - Occurs when the request parameters fail validation.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Response
The response is of type object.
The response is of type object.
The response is of type object.