Retrieve

API Reference

Messages

Get a specific message

client.messages.retrieve(, ?): MessageRetrieveResponse { data, status }

get/api/v2/messages/{message_id}

Retrieve details of a specific message by its ID

ParametersExpand Collapse

messageID: string

ReturnsExpand Collapse

MessageRetrieveResponse { data, status }

data?: Data { accountEmail, content, date_sent, 22 more }

accountEmail?: string

Email of the account

content?: string

Message content

date_sent?: string

When the message was sent

formatdate-time

date_updated?: string

When the message was last updated

formatdate-time

error_code?: number | null

Numeric error code if message failed

error_detail?: string | null

Detailed error information

error_message?: string | null

Error message if message failed

error_reason?: string | null

Error reason if message failed

from_number?: string

Sender phone number

group_display_name?: string | null

Display name for group messages

group_id?: string | null

Group ID for group messages

is_outbound?: boolean

Whether this is an outbound message

media_url?: string | null

URL of attached media

message_handle?: string

Unique message identifier

message_type?: "message" | "group"

Accepts one of the following:

"message"

"group"

number?: string

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

opted_out?: boolean

Whether the recipient has opted out

participants?: Array<string>

List of participants for group messages

plan?: string

Account plan used for this message

send_style?: "celebration" | "shooting_star" | "fireworks" | 10 more

The iMessage expressive message style

Accepts one of the following:

"celebration"

"shooting_star"

"fireworks"

"lasers"

"love"

"confetti"

"balloons"

"spotlight"

"echo"

"invisible"

"gentle"

"loud"

"slam"

sendblue_number?: string | null

Sendblue phone number used

service?: "iMessage" | "SMS"

Accepts one of the following:

"iMessage"

"SMS"

status?: "REGISTERED" | "PENDING" | "SENT" | 7 more

Accepts one of the following:

"REGISTERED"

"PENDING"

"SENT"

"DELIVERED"

"RECEIVED"

"QUEUED"

"ERROR"

"DECLINED"

"ACCEPTED"

"SUCCESS"

to_number?: string

Recipient phone number

was_downgraded?: boolean

Whether the message was downgraded from iMessage to SMS

status?: string

Get a specific message

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);

{
  "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"
}

Returns Examples

{
  "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"
}