Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Message Queue → Get Queue Messages

AI-generated

Summary

Retrieves a paginated list of messages currently queued for sending via Z-API.

Inputs

  • page (required) — Page number for paginating results (must be a positive integer greater than zero).
  • pageSize (required) — Number of messages to return per page (must be a positive integer greater than zero; maximum is 1000).

Output shape

An array of items, each containing the JSON response from the Z-API queue listing endpoint.

The response structure depends on the Z-API endpoint; use the 'API' resource with 'Make API Call' to inspect the exact schema.

Examples

Example 1: Retrieve the first 50 messages in the queue

Page: 1, PageSize: 50

Example 2: Fetch the second page of messages

Page: 2, PageSize: 100

Links

Discussion