Skip to content
SendBlue Docs
  • Auto
  • Light
  • Dark
Get Started

Retrieve

API Reference
Messages
Get a specific message
client.messages.retrieve(stringmessageID, RequestOptionsoptions?): dataDatastatusstringMessageRetrieveResponse
get/api/v2/messages/{message_id}

Retrieve details of a specific message by its ID

Parameters
messageIDstring
Returns
MessageRetrieveResponse
Hide ParametersShow Parameters
dataaccountEmailstringcontentstringdate_sentstringdate_updatedstringerror_codeunionerror_detailunionerror_messageunionerror_reasonunionfrom_numberstringgroup_display_nameuniongroup_idunionis_outboundbooleanmedia_urlunionmessage_handlestringmessage_typeunionnumberstringopted_outbooleanparticipantsarrayplanstringsend_styleunionsendblue_numberunionserviceunionstatusunionto_numberstringwas_downgradedbooleanData
optional
Hide ParametersShow Parameters
accountEmailstring
optional

Email of the account

contentstring
optional

Message content

date_sentstring
optional

When the message was sent

formatdate-time
date_updatedstring
optional

When the message was last updated

formatdate-time
error_codeunion
optional
number | null

Numeric error code if message failed

error_detailunion
optional
string | null

Detailed error information

error_messageunion
optional
string | null

Error message if message failed

error_reasonunion
optional
string | null

Error reason if message failed

from_numberstring
optional

Sender phone number

group_display_nameunion
optional
string | null

Display name for group messages

group_idunion
optional
string | null

Group ID for group messages

is_outboundboolean
optional

Whether this is an outbound message

media_urlunion
optional
string | null

URL of attached media

message_handlestring
optional

Unique message identifier

message_typeunion
optional
"message" | "group"
Hide ParametersShow Parameters
"message"
"group"
numberstring
optional

Primary phone number (to_number for outbound, from_number for inbound)

opted_outboolean
optional

Whether the recipient has opted out

participantsarray
optional
Array<string>

List of participants for group messages

planstring
optional

Account plan used for this message

send_styleunion
optional
"celebration" | "shooting_star" | "fireworks" | 10 more

The iMessage expressive message style

Hide ParametersShow Parameters
"celebration"
"shooting_star"
"fireworks"
"lasers"
"love"
"confetti"
"balloons"
"spotlight"
"echo"
"invisible"
"gentle"
"loud"
"slam"
sendblue_numberunion
optional
string | null

Sendblue phone number used

serviceunion
optional
"iMessage" | "SMS"
Hide ParametersShow Parameters
"iMessage"
"SMS"
statusunion
optional
"REGISTERED" | "PENDING" | "SENT" | 7 more
Hide ParametersShow Parameters
"REGISTERED"
"PENDING"
"SENT"
"DELIVERED"
"RECEIVED"
"QUEUED"
"ERROR"
"DECLINED"
"ACCEPTED"
"SUCCESS"
to_numberstring
optional

Recipient phone number

was_downgradedboolean
optional

Whether the message was downgraded from iMessage to SMS

statusstring
optional
import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const message = await client.messages.retrieve('msg_abc123def456');

console.log(message.data);
200 Example
{
  "data": {
    "accountEmail": "[email protected]",
    "content": "Hello, World!",
    "date_sent": "2024-01-01T12:00:00Z",
    "date_updated": "2024-01-01T12:00:01Z",
    "error_code": null,
    "error_detail": null,
    "error_message": null,
    "error_reason": null,
    "from_number": "+19998887777",
    "group_display_name": null,
    "group_id": null,
    "is_outbound": true,
    "media_url": null,
    "message_handle": "msg_abc123def456",
    "message_type": "message",
    "number": "+18887776666",
    "opted_out": false,
    "participants": [
      "string"
    ],
    "plan": "premium",
    "send_style": "celebration",
    "sendblue_number": "+19998887777",
    "service": "iMessage",
    "status": "SENT",
    "to_number": "+18887776666",
    "was_downgraded": false
  },
  "status": "OK"
}