Request Code (Phone Login)
Requests a linking code for phone-based WhatsApp authentication (OTP style).
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Use this as a fallback for users with broken cameras.
Display the 8-character code in a large, clear font with a countdown.
Ensure the session is in 'SCAN_QR_CODE' status before requesting.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | The 12-character ID of the instance Example: | ||
string | Your API Access Token Example: | ||
string | The phone number to link (e.g., 201145202826) Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"code": "ABCD-1234"
}Command Palette
Search for a command to run...