--- title: "Sync chat messages on demand" method: POST path: "/v1/chat/syncMessages/{instance}" tags: ["Chat"] --- # Sync chat messages on demand `POST /v1/chat/syncMessages/{instance}` ## Request - Base URL: `http://localhost:8080` - URL: `http://localhost:8080/v1/chat/syncMessages/{instance}` - Auth: API key in header `apikey` 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. ## Path parameters - `instance` string, required ## Request body - DtoSyncChatMessagesRequest - `count` integer - `fromMe` boolean - `id` string, required - `number` string, required - `since` string ## Response `200` Messages synced from the chat - WhatsmiauWookMessageData[] - `contextInfo` WhatsmiauWookMessageContextInfo - `conversionData` string - `conversionDelaySeconds` integer - `conversionSource` string - `disappearingMode` WhatsmiauContextInfoDisappearingMode - `initiatedByMe` boolean - `initiator` string - `trigger` string - `entryPointConversionApp` string - `entryPointConversionDelaySeconds` integer - `entryPointConversionSource` string - `ephemeralSettingTimestamp` string - `expiration` integer - `externalAdReply` WhatsmiauWookMessageContextInfoExternalAdReply - `body` string - `containsAutoReply` boolean - `ctwaClid` string - `mediaType` string - `renderLargerThumbnail` boolean - `showAdAttribution` boolean - `sourceId` string - `sourceType` string - `sourceUrl` string - `thumbnail` string - `thumbnailUrl` string - `title` string - `mentionedJid` string[] - `participant` string - `quotedMessage` WhatsmiauWookMessageRaw - `audioMessage` WhatsmiauWookAudioMessageRaw - `contextInfo` WhatsmiauFileContextInfo - `disappearingMode` WhatsmiauContextInfoDisappearingMode - `initiatedByMe` boolean - `initiator` string - `trigger` string - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `ptt` boolean - `seconds` integer - `url` string - `viewOnce` boolean - `waveform` string - `base64` string - `contactMessage` WhatsmiauContactMessageRaw - `displayName` string - `vcard` string - `contactsArrayMessage` WhatsmiauContactsArrayMessageRaw - `contacts` WhatsmiauContactMessageRaw[] - `displayName` string - `vcard` string - `displayName` string - `conversation` string - `documentMessage` WhatsmiauWookDocumentMessageRaw - `caption` string - `contactVcard` boolean - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileName` string - `fileSha256` string - `jpegThumbnail` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `pageCount` integer - `title` string - `url` string - `encCommentMessage` WhatsmiauWookEncCommentMessageRaw - `encIv` string - `encPayload` string - `targetMessageKey` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `imageMessage` WhatsmiauWookImageMessageRaw - `caption` string - `contextInfo` WhatsmiauFileContextInfo - `disappearingMode` WhatsmiauContextInfoDisappearingMode - `initiatedByMe` boolean - `initiator` string - `trigger` string - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `height` integer - `jpegThumbnail` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `url` string - `viewOnce` boolean - `width` integer - `interactiveMessage` WhatsmiauWookInteractiveMessageRaw - `body` WhatsmiauWookInteractiveMessageBodyRaw - `text` string - `footer` WhatsmiauWookInteractiveMessageFooterRaw - `text` string - `header` WhatsmiauWookInteractiveMessageHeaderRaw - `title` string - `nativeFlowMessage` WhatsmiauWookNativeFlowMessageRaw - `buttons` WhatsmiauWookNativeFlowButtonRaw[] - `buttonParamsJson` string - `name` string - `messageVersion` integer - `listResponseMessage` WhatsmiauWookListMessageRaw - `buttonText` string - `contextInfo` WhatsmiauWookListMessageRawListContextInfo - `participant` string - `quotedMessage` WhatsmiauWookListMessageRawListContextInfoMessage - `listMessage` WhatsmiauWookListMessageRawListContextInfoMessageList - … - `stanzaId` string - `description` string - `footerText` string - `listType` string - `sections` WhatsmiauWookListSection[] - `rows` WhatsmiauWookListRow[] - `description` string - `rowId` string - `title` string - `title` string - `singleSelectReply` WhatsmiauWookListMessageRawListSingleSelectReply - `selectedRowId` string - `title` string - `liveLocationMessage` WhatsmiauWookLiveLocationMessageRaw - `accuracyInMeters` integer - `caption` string - `degreesClockwiseFromMagneticNorth` integer - `degreesLatitude` number - `degreesLongitude` number - `jpegThumbnail` string - `sequenceNumber` integer - `speedInMps` number - `timeOffset` integer - `locationMessage` WhatsmiauWookLocationMessageRaw - `address` string - `degreesLatitude` number - `degreesLongitude` number - `jpegThumbnail` string - `name` string - `url` string - `mediaUrl` string: Sent when connect with some storage - `pollCreationMessage` WhatsmiauWookPollCreationMessageRaw - `name` string - `options` WhatsmiauWookPollOption[] - `optionName` string - `selectableOptionsCount` integer - `pollUpdateMessage` WhatsmiauWookPollUpdateMessageRaw - `pollCreationMessageKey` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `senderTimestampMs` string - `vote` WhatsmiauWookPollVote - `encIv` string - `encPayload` string - `selectedOptions` string[] - `ptvMessage` WhatsmiauWookPtvMessageRaw - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `jpegThumbnail` string - `mediaKey` string - `mimetype` string - `seconds` integer - `url` string - `reactionMessage` WhatsmiauReactionMessageRaw - `key` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `senderTimestampMs` string - `text` string - `stickerMessage` WhatsmiauWookStickerMessageRaw - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `height` integer - `isAnimated` boolean - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `pngThumbnail` string - `url` string - `width` integer - `videoMessage` WhatsmiauWookVideoMessageRaw - `caption` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `gifPlayback` boolean - `jpegThumbnail` string - `mediaKey` string - `mimetype` string - `seconds` integer - `url` string - `stanzaId` string - `trustBannerAction` integer - `instanceId` string - `key` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `message` WhatsmiauWookMessageRaw - `audioMessage` WhatsmiauWookAudioMessageRaw - `contextInfo` WhatsmiauFileContextInfo - `disappearingMode` WhatsmiauContextInfoDisappearingMode - `initiatedByMe` boolean - `initiator` string - `trigger` string - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `ptt` boolean - `seconds` integer - `url` string - `viewOnce` boolean - `waveform` string - `base64` string - `contactMessage` WhatsmiauContactMessageRaw - `displayName` string - `vcard` string - `contactsArrayMessage` WhatsmiauContactsArrayMessageRaw - `contacts` WhatsmiauContactMessageRaw[] - `displayName` string - `vcard` string - `displayName` string - `conversation` string - `documentMessage` WhatsmiauWookDocumentMessageRaw - `caption` string - `contactVcard` boolean - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileName` string - `fileSha256` string - `jpegThumbnail` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `pageCount` integer - `title` string - `url` string - `encCommentMessage` WhatsmiauWookEncCommentMessageRaw - `encIv` string - `encPayload` string - `targetMessageKey` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `imageMessage` WhatsmiauWookImageMessageRaw - `caption` string - `contextInfo` WhatsmiauFileContextInfo - `disappearingMode` WhatsmiauContextInfoDisappearingMode - `initiatedByMe` boolean - `initiator` string - `trigger` string - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `height` integer - `jpegThumbnail` string - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `url` string - `viewOnce` boolean - `width` integer - `interactiveMessage` WhatsmiauWookInteractiveMessageRaw - `body` WhatsmiauWookInteractiveMessageBodyRaw - `text` string - `footer` WhatsmiauWookInteractiveMessageFooterRaw - `text` string - `header` WhatsmiauWookInteractiveMessageHeaderRaw - `title` string - `nativeFlowMessage` WhatsmiauWookNativeFlowMessageRaw - `buttons` WhatsmiauWookNativeFlowButtonRaw[] - `buttonParamsJson` string - `name` string - `messageVersion` integer - `listResponseMessage` WhatsmiauWookListMessageRaw - `buttonText` string - `contextInfo` WhatsmiauWookListMessageRawListContextInfo - `participant` string - `quotedMessage` WhatsmiauWookListMessageRawListContextInfoMessage - `listMessage` WhatsmiauWookListMessageRawListContextInfoMessageList - `buttonText` string - `description` string - `footerText` string - `listType` string - `sections` WhatsmiauWookListSection[] - … - `title` string - `stanzaId` string - `description` string - `footerText` string - `listType` string - `sections` WhatsmiauWookListSection[] - `rows` WhatsmiauWookListRow[] - `description` string - `rowId` string - `title` string - `title` string - `singleSelectReply` WhatsmiauWookListMessageRawListSingleSelectReply - `selectedRowId` string - `title` string - `liveLocationMessage` WhatsmiauWookLiveLocationMessageRaw - `accuracyInMeters` integer - `caption` string - `degreesClockwiseFromMagneticNorth` integer - `degreesLatitude` number - `degreesLongitude` number - `jpegThumbnail` string - `sequenceNumber` integer - `speedInMps` number - `timeOffset` integer - `locationMessage` WhatsmiauWookLocationMessageRaw - `address` string - `degreesLatitude` number - `degreesLongitude` number - `jpegThumbnail` string - `name` string - `url` string - `mediaUrl` string: Sent when connect with some storage - `pollCreationMessage` WhatsmiauWookPollCreationMessageRaw - `name` string - `options` WhatsmiauWookPollOption[] - `optionName` string - `selectableOptionsCount` integer - `pollUpdateMessage` WhatsmiauWookPollUpdateMessageRaw - `pollCreationMessageKey` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `senderTimestampMs` string - `vote` WhatsmiauWookPollVote - `encIv` string - `encPayload` string - `selectedOptions` string[] - `ptvMessage` WhatsmiauWookPtvMessageRaw - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `jpegThumbnail` string - `mediaKey` string - `mimetype` string - `seconds` integer - `url` string - `reactionMessage` WhatsmiauReactionMessageRaw - `key` WhatsmiauWookKey - `addressingMode` string - `fromMe` boolean - `id` string - `participant` string - `remoteJid` string - `remoteLid` string - `senderTimestampMs` string - `text` string - `stickerMessage` WhatsmiauWookStickerMessageRaw - `directPath` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `height` integer - `isAnimated` boolean - `mediaKey` string - `mediaKeyTimestamp` string - `mimetype` string - `pngThumbnail` string - `url` string - `width` integer - `videoMessage` WhatsmiauWookVideoMessageRaw - `caption` string - `fileEncSha256` string - `fileLength` string - `fileSha256` string - `gifPlayback` boolean - `jpegThumbnail` string - `mediaKey` string - `mimetype` string - `seconds` integer - `url` string - `messageTimestamp` integer - `messageType` string - `pollUpdates` WhatsmiauWookPollUpdate[] - `name` string - `voters` string[] - `pushName` string - `source` string - `status` string ## Other responses - `400`: Bad Request - `401`: Unauthorized - `409`: Conflict - `422`: Unprocessable Entity - `500`: Internal Server Error - `504`: Gateway Timeout ## Changes - **2026-09-09** `1c21453ab4d1`: 1 info - endpoint added - **2026-09-08** `151d3fbb2e20`: 1 breaking - api path removed without deprecation - **2026-09-02** `c7c638295e17`: 1 info - endpoint added [Operation history](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/changes/v1/chat/syncMessages/:instance/post.md) --- [API](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api.md) - [All operations](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/llms.txt) - [OpenAPI document](https://skmtc.dev/verbeux-ai/apis/whatsmiau-api/revisions/b425ec589eb0?raw)