object
Message
Message record with content, delivery state, and channel delivery context.
Properties
- Name
revision- Type
- integer
- Description
- Optional property.
- Name
id- Type
- string
- Description
- Required property.
- Name
createdAt- Type
- string
- Description
- When Flownally stored the message. For inbound messages this is after Flownally received the message, not when the customer sent it. Several messages can have the same `createdAt`; keep the order the API returns.
- Name
updatedAt- Type
- string
- Description
- Required property.
- Name
tenantId- Type
- string
- Description
- Required property.
- Name
conversationId- Type
- string
- Description
- Required property.
- Name
sessionId- Type
- string
- Description
- Required property.
- Name
senderType- Type
- enum
- Description
- Required property. Allowed values: customer, user, journey, bot, campaign, service_account, inbox.
- Name
senderId- Type
- string
- Description
- Required property.
- Name
content- Type
- object
- Description
- Message content, or null when the message has been deleted.
- Name
deliveryStatus- Type
- enum
- Description
- Delivery state of the message. Statuses only move forward: - `pending` can become `unknown`, `sent`, `delivered`, `read` or `failed`. - `unknown` can become `sent`, `delivered`, `read` or `failed`. - `sent` can become `delivered`, `read` or `failed`. - `delivered` can become `read`. - `read` and `failed` are final. `unknown` means the call to the channel ended without a clear result, so the message may have been delivered. Don't resend it automatically. Allowed values: pending, sent, delivered, read, failed, unknown.
- Name
channelMessageId- Type
- string
- Description
- Optional property.
- Name
clientMessageId- Type
- string
- Description
- Client-generated correlation key echoed from Idempotency-Key for outbound sends.
- Name
failureReason- Type
- string
- Description
- Short human-readable description of the failure when `deliveryStatus` is `failed`. It isn't a stable code; don't parse it.
- Name
editedAt- Type
- string
- Description
- Optional property.
- Name
deletedAt- Type
- string
- Description
- Optional property.
- Name
reactions- Type
- array<Reaction>
- Description
- Optional property.
- Name
contexts- Type
- array<MessageContext>
- Description
- Optional property.