Send Message

API Reference

Groups

Send a group message

client.groups.sendMessage(GroupSendMessageParamsbody, RequestOptionsoptions?): account_emailstringcontentstringdate_createdstringdate_updatedstringerror_codenumbererror_messagestringfrom_numberstringis_outboundbooleanmedia_urlstringmessage_handlestringnumberstringsend_styleunionstatusunionMessageResponse

post/api/send-group-message

Send a message to a group of recipients (beta feature)

Parameters

bodycontentstringfrom_numberstringgroup_idstringmedia_urlstringnumbersarrayGroupSendMessageParams

Hide ParametersShow Parameters

contentstring

Message text content

from_numberstring

REQUIRED - The phone number to send from. Must be one of your registered Sendblue phone numbers in E.164 format. Without this parameter, the message will fail to send.

group_idstring

optional

Unique identifier for an existing group

media_urlstring

optional

URL of media file to send

formaturi

numbersarray

optional

Array<string>

Array of recipient phone numbers in E.164 format

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.groups.sendMessage({
  content: 'Hello, everyone!',
  from_number: '+19998887777',
});

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