Skip to main content
POST
whatsapp.inbound-messages.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
connectionRef
string
required

Owned sender account identifier from social.accounts.list, as used for WhatsApp sends.

Required string length: 1 - 256
since
string

Opaque continuation returned for this sender; omit to start a new history sweep.

Maximum string length: 1024
limit
integer
default:50

Maximum messages per page.

Required range: 1 <= x <= 100

Response

The result

messages
object[]
required

Inbound direct messages only, excluding deleted messages.

Maximum array length: 100
nextCursor
string

Opaque polling checkpoint. Keep passing it, including after an empty page. A sweep reads messages by their recorded timestamp; delayed older history may require a new sweep.

Maximum string length: 1024