INinkbox
WhatsApp

List Messages

Changed on
get/api/v1/whatsapp/messages

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/whatsapp/messages
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

agent_identity_idstring uuid nullable
conversation_idstring uuid nullable
offsetinteger
limitinteger
is_readboolean nullable
is_blockedboolean nullable
thread_idstring uuid nullable
start_datetimestring nullable

Filter created_at >= this date/datetime. Bare date => whole day in tz.

end_datetimestring nullable

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

tzstring nullable

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

Response

Successful Response

idstring uuid required
agent_identity_idstring uuid required
conversation_idstring uuid required
direction'inbound' | 'outbound' required
local_numberstring required
remote_numberstring required
sender_numberstring required
participantsstring[] required
reply_to_message_idstring uuid nullable
thread_idstring uuid nullable
thread_root_message_idstring uuid nullable
contentstring nullable required
status'received' | 'queued' | 'sending' | 'sent' | 'delivered' | 'failed' | 'uncertain' | 'cancelled' required
delivery_state'pending' | 'delivered' | 'unknown' required
is_readboolean required
is_blockedboolean required
error_codestring nullable required
error_detailstring nullable required
source_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required
sent_atstring date-time nullable required
delivered_atstring date-time nullable required
failed_atstring date-time nullable required
status_observed_atstring date-time nullable required
status_refresh_pendingboolean required

Changes