Skip to main content
GET

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

YCloud outbound record ID as a positive decimal Long string, without signs or leading zeroes; never a Meta message ID. Nonmatching paths return 404; Long overflow returns 400.

Minimum string length: 1
Pattern: ^[1-9][0-9]{0,18}$

Query Parameters

from
string
required

Nonblank Facebook Page ID, matched exactly within the authenticated tenant.

Required string length: 1 - 64

Response

The current locally stored outbound record, including rejected or unknown submission results. Null optional fields are omitted. Query success is 200 even when the message was rejected. Includes active reactions reconstructed from saved events, or [] when none remain. Only interactions saved after reaction persistence was enabled are available.

id
string
required

YCloud outbound ID, a decimal string; never serialize it as a JSON number.

from
string
required

Facebook Page ID.

to
string
required

Peer PSID for this Page.

type
enum<string>
required
Available options:
text
text
object
required
status
enum<string>
required

Current stored facts: read > delivered > sent > submission result. Unknown means unconfirmed or in progress, never a definitive failure. Missing receipts do not imply failure and no intermediate state is fabricated.

Available options:
unknown,
accepted,
rejected,
sent,
delivered,
read
createTime
string<date-time>
required

Local creation time in UTC RFC 3339 with millisecond precision.

updateTime
string<date-time>
required

Local update time in UTC RFC 3339 with millisecond precision.

metaMessageId
string

Omitted when no Meta ID is confirmed.

reactions
object[]

Active reactions reconstructed when retrieving an outbound message. Returns [] when no saved active reaction exists, including after withdrawal. Customer status webhooks omit this field; receiving a reaction does not change the message delivery status or updateTime.

errorCode
string

Locally recorded submission error, when present. A confirmed rejection may be MESSENGER_MESSAGE_REJECTED(#100:2018276), MESSENGER_MESSAGE_REJECTED(#100), or the legacy MESSENGER_MESSAGE_REJECTED when diagnostics are unavailable. MESSENGER_MESSAGE_RESULT_UNKNOWN means the submission outcome is unconfirmed. Never contains the raw Meta error body or credentials.

sendTime
string<date-time>

Confirmed send time in UTC RFC 3339 with millisecond precision; omitted when unknown.

deliverTime
string<date-time>

Confirmed delivery time in UTC RFC 3339 with millisecond precision; omitted when unknown.

readTime
string<date-time>

Confirmed read time in UTC RFC 3339 with millisecond precision; omitted when unknown.