InboxMessage

idstring

conversationIdstring

directionstring

Possible values: [in, out, note, event]

originstring

Where the message came from. Replies by API key show as agent, with a null sender.

Possible values: [contact, agent, broadcast, flow, api, proxy, app, system]

typestring

Possible values: [text, template, image, video, audio, document, sticker, location, contacts, interactive, button, reaction, order, system, unsupported]

content object

The content in Meta's Cloud API format.

property name*any

The content in Meta's Cloud API format.

statusstring

Possible values: [pending, accepted, sent, delivered, read, failed, unknown, received, recorded]

errorCodeintegernullable

errorstringnullable

contextWamidstringnullable

wamidstringnullable

sender objectnullable

idstring

namestring

broadcastIdstringnullable

media objectnullable

idstring

kindstring

Possible values: [image, video, audio, document, sticker]

mimeTypestring

fileNamestringnullable

sizeBytesintegernullable

statusstring

Example: stored

occurredAtstring<date-time>

sentAtstring<date-time>nullable

deliveredAtstring<date-time>nullable

readAtstring<date-time>nullable

failedAtstring<date-time>nullable

InboxMessage

{
  "id": "string",
  "conversationId": "string",
  "direction": "in",
  "origin": "contact",
  "type": "text",
  "content": {},
  "status": "pending",
  "errorCode": 0,
  "error": "string",
  "contextWamid": "string",
  "wamid": "string",
  "sender": {
    "id": "string",
    "name": "string"
  },
  "broadcastId": "string",
  "media": {
    "id": "string",
    "kind": "image",
    "mimeType": "string",
    "fileName": "string",
    "sizeBytes": 0,
    "status": "stored"
  },
  "occurredAt": "2024-07-29T15:51:28.071Z",
  "sentAt": "2024-07-29T15:51:28.071Z",
  "deliveredAt": "2024-07-29T15:51:28.071Z",
  "readAt": "2024-07-29T15:51:28.071Z",
  "failedAt": "2024-07-29T15:51:28.071Z"
}