Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Messages

Send SMS message

The method is used for sending an SMS message to a contact. A new contact is created if no contact with such phone number exists.

post/api/v1/message/sms

Request body

fromstring required

Sender name. Enter one of the valid sender names

textstring required

Message text

phoneNumbersstring[]

<b>Required parameter</b>, if "groupId" is not specified.

tagsstring[]

The list of tags to be assigned to a message.

groupIdinteger

<b>Required parameter</b>, if "phoneNumbers" is not specified. Segment ID to which the message will be sent

externalRequestIdstring

External request ID. It is the same for all the recipients.

subscriptionsKeysstring[]
trackUrlsboolean

The parameter determines whether to track links in a message or not. The default value is ‘false’.

Example request

{
  "from": "John Smith",
  "text": "Thank you for subscribing to our Newsletters",
  "groupId": 201234567
}