Get Detail by Request ID

This API lets you fetch the list of contacts (and their individual status) for a specific WhatsApp template campaign, using its request_id. Results are paginated, so it's suited for campaigns with a large number of contacts.

Endpoint

GET {{base_url}}/v6/api/whatsappTemplate/24/{{username}}/messages/{{request_id}}/contacts

{{base_url}} = https://wa20.nuke.co.in

Path Parameters

Parameter	Type	Required	Description
username	string	Yes	Your account username.
request_id	string	Yes	The unique campaign/request ID whose contacts you want to fetch.

The 24 segment in the path is a fixed part of the route — confirm with your team what it represents (e.g. a template/module version) before publishing, in case it needs to be documented as a variable.

Query Parameters

Parameter	Type	Required	Default	Description
page	integer	No	1	Page number of results to fetch.
limit	integer	No	50	Number of contacts to return per page.

Example Request

GET {{base_url}}/v6/api/whatsappTemplate/24/{{username}}/messages/{{request_id}}/contacts?page=1&limit=50

---

Example Response

JSON

{
    "success": true,
    "data": [
        {
            "receiver": "91XXXXXXXXXX",
            "status": "Pending",
            "dat": "2026-07-31",
            "tim": "18:36:39",
            "template_id": "test"
        },
        {
            "receiver": "91XXXXXXXXXX",
            "status": "Pending",
            "dat": "2026-07-31",
            "tim": "18:36:39",
            "template_id": "test"
        }
    ],
    "pagination": {
        "total": 30970,
        "page": 1,
        "limit": 50,
        "totalPages": 620
    }
}

---

Response Fields

Top level

Field	Type	Description
success	boolean	Whether the request was processed successfully.
data	array	List of contact records for this campaign (see below).
pagination	object	Pagination metadata for the result set.

data[]

Each item represents one contact/recipient in the campaign.

Field	Type	Description
receiver	string	Recipient phone number (with country code, no +).
status	string	Current delivery/processing status of the message for this contact — see Status Reference below.
dat	string	Date the record was created/updated (YYYY-MM-DD).
tim	string	Time the record was created/updated (HH:MM:SS).
template_id	string	Name/ID of the WhatsApp template used for this contact.

pagination

Field	Type	Description
total	integer	Total number of contacts in this campaign, across all pages.
page	integer	The current page number returned.
limit	integer	Number of records per page, as requested.
totalPages	integer	Total number of pages available (ceil(total / limit)).

---

Status Reference

status value	Meaning
Pending	Message is queued and hasn't started processing yet.
Sending	Message is currently being sent to WhatsApp.
Sent	Message has been accepted and sent by WhatsApp, but delivery to the recipient's device isn't confirmed yet.
Delivered	Message has reached the recipient's device (single/double grey tick).
read	Recipient has opened/read the message (blue tick).
failed	Message could not be sent or delivered.
insufficient	Message wasn't sent due to insufficient account balance/credits.
N/A	No status available for this contact (e.g. invalid number, or status not yet reported back).

---

Notes

• Use page and limit together to paginate through large campaigns — totalPages in the response tells you how many pages exist in total.
• This endpoint only returns contacts for the given request_id; it does not aggregate results across campaigns.
• Pair this with your final delivery report/webhook for a complete view — this endpoint reflects the state at the time of the request, and re-fetching will show the latest status for each contact.