Messages

Get Message by ID

Retrieve a previously sent message.

get/messages/{id}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/messages/{id}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

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.

costnumber double nullable required

Total cost charged for sending the message. <br>

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

deliveredAtstring nullable required

Timestamp indicating when the message was successfully delivered to the recipient. <br>

Null indicates the message has not yet been delivered.

errorstring nullable required

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

Null indicates no errors.

idstring required

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

method'API' | 'SDK' | 'OTHER' required

Method used to send the message.

numSegmentsinteger required

Number of segments the message was split into for delivery.

receiverstring required

Phone number that received the message in E.164 format.

senderstring required

Phone number or agent that sent the message.

sentAtstring nullable required

Timestamp indicating when the message was submitted for delivery. <br>

Null indicates the message is still in the queue.

status'QUEUED' | 'PENDING' | 'SENT' | 'SEND_FAILED' | 'DELIVERED' | 'DELIVERY_FAILED' | 'RECEIVED' | 'READ' | 'FALLBACK_SENT' required

Current status of the message.

type'SMS' | 'MMS' | 'RCS' required

Delivery protocol used for sending this message.

Changes

No recorded changes to this operation across all 1 revision of this API.