API ReferenceMessages

Get Message by ID

Retrieve a previously sent message.

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired

Unique identifier of the message. This identifier is a string that always begins with the prefix msg_, for example: msg_1234567890.

Response

Successfully retrieved the message.
contentobject
Content type of the message.
costdouble or null

Total cost charged for sending the message.

Null means the message incurred no cost or has not been charged yet.

deliveredAtstring or null

Timestamp indicating when the message was successfully delivered to the recipient.

Null indicates the message has not yet been delivered.

errorstring or null

Detailed explanation of any errors that occurred while delivering the message.

Null indicates no errors.

idstring

Unique identifier of the message. This identifier is a string that always begins with the prefix msg_, for example: msg_1234567890.

methodenum
Method used to send the message.
Allowed values:
numSegmentsinteger
Number of segments the message was split into for delivery.
receiverstring
Phone number that received the message in E.164 format.
senderstring
Phone number or agent that sent the message.
sentAtstring or null

Timestamp indicating when the message was submitted for delivery.

Null indicates the message is still in the queue.

statusenum
Current status of the message.
typeenum
Delivery protocol used for sending this message.
Allowed values:
fallbackobject or null

The fallback SMS/MMS message configuration for this RCS message.

Null indicates no fallback was configured for this message. Only applicable for RCS messages.

The original RCS message with have status FALLBACK_SENT when the fallback message was sent instead.

Errors