Skip to main content
POST
Request older chat history from the phone

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id
string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Path Parameters

chat_jid
string
required

Chat JID (e.g., phone@s.whatsapp.net for individual or groupid@g.us for group). Percent-encoded values (e.g., groupid%40g.us) are accepted.

Body

application/json
count
integer
default:50

Number of older messages to request from the phone. Omit it, or send 0, to use the default of 50.

Required range: 0 <= x <= 500
Example:

50

Response

OK

status
integer
Example:

200

code
string
Example:

"SUCCESS"

message
string
Example:

"History sync requested successfully"

results
object