Sign in

v1

latestOpenAPI 3.0.0raw.githubusercontent.com2025-10-15121927.4 KB
Messages

Get message details

Retrieve full message metadata including direction, protocol, text length, attachments count, timestamps, current status, and original metadata.

get/v1/api/messages/{messageId}

Response

Message metadata and current status.

message_idstring
api_keystring
external_idstring

Recipient phone number.

direction'outbound' | 'inbound'
text_lengthinteger
attachments_countinteger
time_sentinteger

Unix timestamp (ms) when the message was queued/sent.

status'pending' | 'queued' | 'sent' | 'delivered' | 'failed' | 'cancelled' | 'cancellation_requested'

Current delivery status.

metadataobject

Original metadata provided plus system generated fields.

protocolstring

The protocol used to send the message (e.g., imessage, rcs, sms).

Example response

{
  "protocol": "imessage"
}