IllyVoIPdevelopers Back to IllyVoIP

WhatsApp

Read messages in a WhatsApp conversation

Read messages in a WhatsApp conversation

Try in API Playground ↗Sign in to prepare and run this request.
GET/api/v1/whatsapp/conversations/messages

Before you start

Connect your business and number in Portal → WhatsApp → Numbers & accounts first. Use an account-owner Production API key. Create templates in the Portal.

Result

Read up to 20 messages newest first in an owned conversation. Use next_cursor as after for older messages. Includes verified decrypted content where available. Does not mark the conversation read, send a receipt, change consent or send messages.

Charges and safe retries

Inspect uncertain operations before retrying. A queued message is not delivered. IllyVoIP reserves its fee at queue admission and charges only delivered outbound messages; incoming messages are free.

Authentication

Send your account API key in the X-Api-Key header. Keep it on your server; never embed it in browser code.

Request examples

Replace the example values with your own inputs. Examples do not run on this page. Production requests can change your account or incur charges.

cURL

cURL
curl -X GET "https://app.illyvoip.com/api/v1/whatsapp/conversations/messages?thread_id=YOUR_THREAD_ID" \
  -H "X-Api-Key: ${ILLYVOIP_API_KEY:?Set ILLYVOIP_API_KEY}"

Node.js

Node.js
const response = await fetch("https://app.illyvoip.com/api/v1/whatsapp/conversations/messages?thread_id=YOUR_THREAD_ID", {
  method: "GET",
  headers: {
    "X-Api-Key": process.env.ILLYVOIP_API_KEY
  }
});

const data = await response.json();
console.log(response.status, data);

PHP

PHP
<?php
$ch = curl_init('https://app.illyvoip.com/api/v1/whatsapp/conversations/messages?thread_id=YOUR_THREAD_ID');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-Api-Key: ' . getenv('ILLYVOIP_API_KEY')
    ],
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo $status . PHP_EOL;
echo $response;

Python

Python
import os
import json
import requests

response = requests.request(
    "GET",
    "https://app.illyvoip.com/api/v1/whatsapp/conversations/messages?thread_id=YOUR_THREAD_ID",
    headers={
        "X-Api-Key": os.environ["ILLYVOIP_API_KEY"]
    },
)

print(response.status_code)
print(response.json())

Node.js examples run on the server (Node.js 22.17+). Python examples require requests; PHP examples require cURL. Set the environment variables referenced in each example.

Request parameters

Query parameters

thread_idintegerrequired
minimum 1
afterstringoptional
pattern "^[a-f0-9]{48}$"

Request behavior

Read up to 20 messages newest first in an owned conversation. Use next_cursor as after for older messages. Includes verified decrypted content where available. Does not mark the conversation read, send a receipt, change consent or send messages.

Conditions and examples

Production only; no WhatsApp Sandbox is available. Replace placeholders with your own account data. Response examples are abbreviated; use the OpenAPI schemas for the full contract. Meta bills its charges separately.

Response fields

  • data: Endpoint-specific result object. Its nested fields are shown in the sample response.

HTTP responses

Expand a status to inspect its documented response format and examples. Example prices, IDs and timestamps are illustrative values, not quotes or account records.

200 Owner-scoped result. Uploading a file does not send a message or confirm delivery.

application/json

successbooleanrequired
dataobjectrequired
Full schema
Schema
{
  "type": "object",
  "required": [
    "success",
    "data"
  ],
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object"
    }
  }
}
400 Invalid request.
401 Invalid API credential.
403 Account or action not authorized.
409 Unavailable operation, idempotency conflict, in-progress operation or recovery required.
503 Temporarily unavailable; do not repeat with a new identity when the previous outcome is unknown.

Production only

This operation is not available in Sandbox. Use an enabled Production account and review its effects before executing.

Search API operations, parameters, SDK and webhooks.