Chat

Sync chat messages on demand

Changed on

Requests message history for a chat from the user's primary device (on-demand history sync). The primary device (phone) must have a server-connected WhatsApp session — history is served from its local message store. The id anchor is required: history is returned backwards from it, count messages per page (default 50). Optionally paginates back to a target date with since. A single request returns at most 500 messages. Recommended not to be used for bulk history extraction.

post/v1/chat/syncMessages/{instance}

Request

  • Base URL
    http://localhost:8080
  • Auth
    API key in header apikey

Path parameters

instancestring required

Instance ID

Request body

countinteger
fromMeboolean
idstring required
numberstring required
sincestring

Response

Messages synced from the chat

instanceIdstring
messageTimestampinteger
messageTypestring
pushNamestring
sourcestring
statusstring

Changes