Check Number Is On Whatsapp

This endpoint allows you to verify whether a number is on whatsapp

Endpoint

Make a POST request to the following endpoint:

URL: /whatsapp/check-number

Request Headers

Include the API key as an Authorization header using the Bearer token scheme.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request Body

The request body should contain the following parameters:

• phoneNumber (string, required): The recipient's phone number in international format (e.g., +254712345678).

Example Request

• POST /whatsapp/check-number
• Authorization: Bearer YOUR_API_KEY
• Content-Type: application/json

{
    "phoneNumber": "+254712345678",
}

Successful Response

One the check is complete, you will receive the following response:

{
    "message": "Check complete",
    "status": true
}

The status will be true or false depending on whether the number provided is available on whatsapp or not

Error Responses

If there are any errors in the request, you will receive one of the following error responses:

2. "Invalid Phone Number Format": The provided phone number is not a valid number in international format.
3. "Missing required inputs": One or more required parameters are missing in the request.