Skip to main content
GET
Get a message by id

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Minimum string length: 1

Response

Success

id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
projectId
string
required
Minimum string length: 1
type
string
required
Minimum string length: 1
sender
object
required
timestamp
string<date-time>
required
status
enum<string>
required
Available options:
PENDING,
SENT,
RECEIVED,
READ,
PLAYED,
FAILED
archivedAt
string<date-time>
chatId
string
Minimum string length: 1
readBy
object
deletedAt
string<date-time>
editedId
string
Minimum string length: 1
repliedId
string
Minimum string length: 1
forwardedId
string
Minimum string length: 1
content
object
error
string

A FAILED message's error, as the provider or the API gave it.

errorCode
string

A FAILED message's code: the provider's (Meta's error number, as text) when it gave one, else the API's (e.g. CONTACT_UNREACHABLE_BY_PROVIDER, TEMPLATE_NOT_FOUND).

errorCategory
enum<string>

What a FAILED message's failure was about: TEMPLATE (the template was refused, paused or not approved), OUTSIDE_WINDOW (sent outside the 24 h window, where only a template goes), RECIPIENT (the number cannot receive it), CHANNEL (the channel cannot send: disconnected, blocked, unpaid) or OTHER.

Available options:
TEMPLATE,
OUTSIDE_WINDOW,
RECIPIENT,
CHANNEL,
OTHER