WhatsApp OTP

Rollout Email supports two connection methods:

• Free Connection (QR Code / Baileys)

Both connection methods use the same API endpoint for outbound OTP delivery.

How the Integration Works

Free Connection — QR Code / Baileys

The Free Connection pairs an existing WhatsApp mobile session with Rollout Email by scanning a QR code.

It is suitable for:

• Transactional OTPs

• Alerts

• Applications that want to avoid per-message fees

The WhatsApp account is linked through the internal Baileys-based connection engine.

End-User Setup Guide

1. Add a New WhatsApp Account

1. Log in to your Rollout Email dashboard.

2. Navigate to WhatsApp Accounts.

3. Click New WhatsApp Account.

4. Enter an Account Label.

For example:

Checkout OTP

or:

Support Line

5. Select the Connection Type:

   • Free (Scan QR)

   • Meta Cloud API

6. Enter the Sender WhatsApp Number, including the country code.

7. Click Create.

Connection Type

2. Link Your WhatsApp Device

This step is required only when using Free (Baileys) connections.

After creating the account:

1. Open the WhatsApp Accounts list.

2. Locate the newly created account.

3. Click Scan QR.

4. Open WhatsApp on your mobile phone.

5. Go to Settings → Linked Devices.

On Android, you can also access Linked Devices through the three-dot menu.

6. Tap Link a Device.

7. Point your phone's camera at the QR code displayed in the Rollout Email dashboard.

8. Wait for the account to connect.

9. Close the QR window.

The account status will update to Connected after the WhatsApp session has been successfully linked.

3. Send a Test OTP

You can verify the WhatsApp connection directly from the dashboard.

1. Locate the connected WhatsApp account.

2. Click Test OTP.

3. Enter the recipient's WhatsApp phone number, including the country code.

4. Click Send Test OTP.

5. Check the recipient's WhatsApp account for the verification code.

This allows you to confirm that the connection is working before integrating it into your application.

4. Integrate the API Into Your Application

Production OTPs can be triggered from your application's backend using an HTTP POST request.

The request should contain:

• The WhatsApp account ID in the URL.

• An API authentication token.

• The recipient's phone number.

• The OTP to be delivered.

Example cURL Request

curl -X POST "https://your-domain.com/api/whatsapp/{ACCOUNT_ID}/send-otp" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "phone": "+919876543210",
    "otp": "492015"
 }'

Replace:

• {ACCOUNT_ID} with your WhatsApp account ID.

• YOUR_API_TOKEN with your API authentication token.

• +919876543210 with the recipient's phone number.

• 492015 with the OTP generated by your application.

API Request Parameters

Successful Response

A successful request returns a response similar to:

{
 "success": true,
 "message": "OTP dispatched successfully."
}

A successful response indicates that the OTP has been dispatched through the configured WhatsApp connection.

Number Formatting

Always provide the destination phone number with its country code.

Examples:

+919876543210

or:

919876543210

Avoid sending a local-format number without the country code.

For example, instead of:

9876543210

use:

+919876543210

Keeping a QR Connection Active

For accounts connected through Free (Baileys):

• Keep the physical mobile device powered on.

• Keep the device connected to the internet.

• Keep the WhatsApp session linked.

• Do not log out of the session from WhatsApp's Linked Devices section.

If you log out or remove the linked session, the connection will need to be established again.

To reconnect:

1. Open WhatsApp Accounts in Rollout Email.

2. Locate the affected account.

3. Click Scan QR.

4. Open WhatsApp on your phone.

5. Go to Settings → Linked Devices.

6. Tap Link a Device.

7. Scan the QR code displayed by Rollout Email.

Free Connection vs. Meta Cloud API

Operational Checklist

Account Setup

• Create a WhatsApp account.

• Enter an account label.

• Select the connection type.

• Enter the sender WhatsApp number.

• Create the account.

Free Connection

• Click Scan QR.

• Open WhatsApp on your phone.

• Open Linked Devices.

• Select Link a Device.

• Scan the displayed QR code.

• Confirm that the status changes to Connected.

API Integration

• Obtain the required API authentication token.

• Identify the WhatsApp account ID.

• Use the /api/whatsapp/{account_id}/send-otp endpoint.

• Include the recipient's country code.

• Send the OTP in the request body.

• Verify the API response.

• Test delivery before enabling production OTPs.

Important Notes

• The Free (Scan QR) connection requires a linked WhatsApp mobile session.

• If the linked WhatsApp session is logged out, the device must be paired again using Scan QR.

• Always include the recipient's country code.

• Keep API authentication credentials private.

• The Meta Cloud API requires the credentials and templates specified by the Meta integration.

• Use the connection type appropriate for your application's delivery and compliance requirements.