Get Status

API Reference

Messages

Get message status

client.messages.getStatus(MessageGetStatusParamsquery, RequestOptionsoptions?): account_emailstringcontentstringdate_createdstringdate_updatedstringerror_codenumbererror_messagestringfrom_numberstringis_outboundbooleanmedia_urlstringmessage_handlestringnumberstringsend_styleunionstatusunionMessageResponse

get/api/status

Retrieve the current status of a message using its message handle. Useful for resolving pending message statuses and avoiding duplicate messages.

Parameters

queryhandlestringMessageGetStatusParams

Hide ParametersShow Parameters

handlestring

The message handle of the message you want to check status for

Returns

account_emailstringcontentstringdate_createdstringdate_updatedstringerror_codenumbererror_messagestringfrom_numberstringis_outboundbooleanmedia_urlstringmessage_handlestringnumberstringsend_styleunionstatusunionMessageResponse

HTTPTypeScript

import SendblueAPI from 'sendblue';

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

const messageResponse = await client.messages.getStatus({ handle: 'msg_abc123def456' });

console.log(messageResponse.account_email);

200 Example

{
  "account_email": "[email protected]",
  "content": "Hello, World!",
  "date_created": "2023-10-01T12:00:00Z",
  "date_updated": "2023-10-01T12:00:01Z",
  "error_code": 0,
  "error_message": "error_message",
  "from_number": "+19998887777",
  "is_outbound": true,
  "media_url": "https://cdn.sendblue.co/media/abc123.jpg",
  "message_handle": "msg_abc123def456",
  "number": "+18887776666",
  "send_style": "celebration",
  "status": "QUEUED"
}