Рекламные/
Сервисные рассылки

Рассылка SMS

E-mail рассылка

Уведомления Вконтакте

Рассылки в Telegram

Каскадные рассылки

Голосовая рассылка

SMS реклама с гео-таргетингом

Авторизация/
Аутентификация

Voice Code

Flash Call

Telegram Gateway
В реестре отечественного ПО

8 800 500-80-16

help@smsgold.ru

Telegram – онлайн помощник по услугам 24/7

Услуги

Тарифы

API

База знаний

Контакты

Рассылки

SMS

VK OK

ЗВОНКИ И ГОЛОСОВЫЕ ОПОВЕЩЕНИЯ

TELEGRAM

КАСКАД

ТОКЕН

E-MAIL

Рассылки

Создание рассылки

Метод создает рассылку со статусом Черновик. Для последующей отправки созданной рассылки используется метод Отправка рассылки или Отправка отложенной рассылки

Пример JSON для запроса

{
  "from_email":"hello@world.com",
  "subject":"Hello World",
  "text":"Hello World",
  "html":"<h1>Hello World</h1>",
  "lists":[
    {
      "id":"1"
    }
  ]
}

Пример запроса

curl -X POST https://app.smsgold.ru/v1/email/campaigns \
     -H 'Content-Type: application/json'              \
     -H 'Authorization: Bearer $API_TOKEN'            \
     -d '...JSON...'

Пример запроса для создания рассылки с вложениями

curl -X POST https://app.smsgold.ru/v1/email/campaigns \
     -H 'Authorization: Bearer $API_TOKEN'       \
     -F from_email=from@example.com              \
     -F subject='Mail with attachments'          \
     -F html='<h1>Hello world</h1>'              \
     -F attachments[]=@/path/to/file1            \
     -F attachments[]=@/path/to/file2

Пример ответа в случае успеха

{
  "id":1,
  "from_email":"hello@world.com",
  "from_name":null,
  "html":"<h1>Hello World</h1>",
  "text":"Hello World",
  "state":"draft",
  "recipients_count":10,
  "purchase":{
    "enable":true,
    "subscribers":10,
    "credits":0,
    "deficit":0
  },
  "statistics":{
    "delivered":1,
    "bounced":0,
    "delivering":0,
    "uniq_open":0,
    "total_open": 0,
    "last_open_at": nil,
    "uniq_click":0,
    "total_click": 0,
    "last_click_at": nil,
    "unsubscription":0,
    "spam":0
  }
}

POST /email/campaigns

Параметры запроса

Параметр Описание Обязательный
from_email Email отправителя Да
subject Тема письма в рассылке Да
from_name Имя отправителя Нет
text Текстовая версия письма Нет
html HTML версия письма Да
segment_id ID сегмента Один из параметров segment_id или lists должен присутствовать
lists Массив групп получателей Один из параметров segment_id или lists должен присутствовать

Элементы массива групп получателей

Параметр Описание Обязательный
id ID группы получателей Да

Ответ сервера

Ответ сервера содержит JSON со следующими атрибутами:

Атрибут Описание
id Идентификатор созданной рассылки
from_email Адрес отправителя
from_name Имя отправителя
html HTML версия письма
text Текстовая версия письма
state Статус (рассылка создается в статусе draft)
recipients_count Количество получателей в рассылке
purchase Информация о тарификации
statistics Статистика рассылки

Статусы рассылки

Значение Описание
draft Черновик
pending На модерации
delayed Запланированная
sending Отправляется
canceled Отменена
stopped Остановлена
completed Завершена
archived В архиве

Информация о тарификации

Атрибут Описание
enable Может принимать значение true (отправка возможна) или false (необходимо улучшить тариф)
subscribers Количество подписчиков которое будет списано из тарифа
credits Количество писем которое будет списано из тарифа
deficit Число на которое необходимо увеличить количество подписчиков или писем в тарифе

Статистика

Атрибут Описание
delivered Количество доставленных сообщений
bounced Количество недоставленный сообщений
delivering Количество доставляющихся сообщений
uniq_open Количество уникальных открытий
total_open Количество открытий всего
last_open_at Timestamp последнего открытия
uniq_click Количество уникальных переходов
total_click Количество переходов всего
last_click_at Timestamp последнего перехода
unsubscription Количество отписок
spam Количество нажатий кнопки "спам"

Отправка рассылки

Метод позволяет отправить рассылку, которая ранее была создана с помощью метода Создание рассылки

Пример запроса

curl -X PATCH https://app.smsgold.ru/v1/email/campaigns/1/deliver \
     -H 'Content-Type: application/json'                    \
     -H 'Authorization: Bearer $API_TOKEN'                  \
     -d '...JSON...'

Пример ответа в случае успеха

{
  "id":1,
  "from_email":"hello@world.com",
  "from_name":null,
  "html":"<h1>Hello World</h1>",
  "text":"Hello World",
  "state":"sending",
  "time_zone":"Fiji",
  "start_at":"30.10.2022 01:00 UTC",
  "recipients_count":10,
  "purchase":{
    "enable":true,
    "subscribers":10,
    "credits":0,
    "deficit":0
  },
  "statistics":{
    "delivered":1,
    "bounced":0,
    "delivering":0,
    "uniq_open":0,
    "total_open": 0,
    "last_open_at": nil,
    "uniq_click":0,
    "total_click": 0,
    "last_click_at": nil,
    "unsubscription":0,
    "spam":0
  }
}

PATCH /email/campaigns/:id/deliver

Отправка отложенной рассылки

Метод позволяет отправить рассылку в заданное время, которая ранее была создана с помощью метода Создание рассылки

Пример JSON для запроса

{
  "start_at": "30.10.2022 13:00",
  "time_zone": "Fiji",
}

Пример запроса

curl -X PATCH https://app.smsgold.ru/v1/email/campaigns/1/schedule \
     -H 'Content-Type: application/json'                     \
     -H 'Authorization: Bearer $API_TOKEN'                   \
     -d '...JSON...'

Пример ответа в случае успеха

{
  "id":1,
  "from_email":"hello@world.com",
  "from_name":null,
  "html":"<h1>Hello World</h1>",
  "text":"Hello World",
  "state":"sending",
  "time_zone":"Fiji",
  "start_at":"30.10.2022 01:00 UTC",
  "recipients_count":10,
  "purchase":{
    "enable":true,
    "subscribers":10,
    "credits":0,
    "deficit":0
  },
  "statistics":{
    "delivered":1,
    "bounced":0,
    "delivering":0,
    "uniq_open":0,
    "total_open": 0,
    "last_open_at": nil,
    "uniq_click":0,
    "total_click": 0,
    "last_click_at": nil,
    "unsubscription":0,
    "spam":0
  }
}

PATCH /email/campaigns/:id/schedule

Параметры запроса

Параметр Описание Обязательный
id ID созданной рассылки Да
start_at Дата и время отправки Нет
time_zone Часовой пояс Нет

Список часовых поясов

Название UTC
International Date Line West -12:00
American Samoa -11:00
Hawaii -10:00
Alaska -09:00
Tijuana -08:00
Arizona -07:00
Saskatchewan -06:00
Lima -05:00
Santiago -04:00
Brasilia -03:00
Mid-Atlantic -02:00
Azores -01:00
UTC +00:00
Paris +01:00
Kaliningrad +02:00
Moscow +03:00
Tehran +03:30
Samara +04:00
Kabul +04:30
Ekaterinburg +05:00
Mumbai +05:30
Kathmandu +05:45
Almaty +06:00
Rangoon +06:30
Bangkok +07:00
Hong Kong +08:00
Osaka +09:00
Adelaide +09:30
Sydney +10:00
Magadan +11:00
Fiji +12:00
Chatham Is. +12:45
Samoa +13:00

Ответ сервера

Ответ сервера содержит JSON со следующими атрибутами:

Атрибут Описание
id Идентификатор
from_email Адрес отправителя
from_name Имя отправителя
start_at Дата и время отправки
time_zone Часовой пояс
html HTML версия письма
text Текстовая версия письма
state Статус
recipients_count Количество получателей
purchase Информация о тарификации
statistics Статистика

Статусы

Значение Описание
draft Черновик
pending На модерации
delayed Запланированная
sending Отправляется
canceled Отменена
stopped Остановлена
completed Завершена
archived В архиве

Информация о тарификации

Атрибут Описание
enable Может принимать значение true (отправка возможна) или false (необходимо улучшить тариф)
subscribers Количество подписчиков которое будет списано из тарифа
credits Количество писем которое будет списано из тарифа
deficit Число на которое необходимо увеличить количество подписчиков или писем в тарифе

Статистика

Атрибут Описание
delivered Количество доставленных сообщений
bounced Количество недоставленный сообщений
delivering Количество доставляющихся сообщений
uniq_open Количество уникальных открытий
total_open Количество открытий всего
last_open_at Timestamp последнего открытия
uniq_click Количество уникальных переходов
total_click Количество переходов всего
last_click_at Timestamp последнего перехода
unsubscription Количество отписок
spam Количество нажатий кнопки "спам"

Список рассылок

Метод позволяет получить весь список рассылок аккаунта.

Пример запроса

curl -X GET https://app.smsgold.ru/v1/email/campaigns?statistic=false \
     -H 'Content-Type: application/json'        \
     -H 'Authorization: Bearer $API_TOKEN'

Данный метод поддерживает постраничную выдачу результатов.

Пример ответа в случае успеха

{
  "total_count": 1,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "id": 1,
      "from_email": "test@example.com",
      "from_name": "Test",
      "html": "<p>test</p>",
      "text": "test",
      "state": "draft",
      "recipients_count": 10,
      "purchase": {
        "enable": true,
        "subscribers": 0,
        "credits": 10,
        "deficit": 0
      },
      "statistics":{
        "delivered":1,
        "bounced":0,
        "delivering":0,
        "uniq_open":0,
        "total_open": 0,
        "last_open_at": nil,
        "uniq_click":0,
        "total_click": 0,
        "last_click_at": nil,
        "unsubscription":0,
        "spam":0
      }
    }
  ]
}

GET /email/campaigns

Ответ сервера

Ответ сервера содержит коллекцию рассылок. Подробнее об элементах коллекции в описании метода "Создание рассылки".

Поддерживаемые параметры

Параметр Описание
statistic Включать блок statistics в выдачу. Возможные значения: true, false.
По умолчанию true. Выключение статистики существенно ускоряет работу метода.

Информация о рассылке

Пример запроса

curl -X GET https://app.smsgold.ru/v1/email/campaigns/1 \
     -H 'Content-Type: application/json'               \
     -H 'Authorization: Bearer $API_TOKEN'

Пример ответа в случае успеха

{
  "id":1,
  "from_email":"hello@world.com",
  "from_name":null,
  "html":"<h1>Hello World</h1>",
  "text":"Hello World",
  "state":"sending",
  "recipients_count":10,
  "purchase":{
    "enable":true,
    "subscribers":10,
    "credits":0,
    "deficit":0
  },
  "statistics":{
    "delivered":1,
    "bounced":0,
    "delivering":0,
    "uniq_open":0,
    "total_open": 0,
    "last_open_at": nil,
    "uniq_click":0,
    "total_click": 0,
    "last_click_at": nil,
    "unsubscription":0,
    "spam":0
  }
}

GET /email/campaigns/:id

Ответ сервера содержит JSON со следующими атрибутами:

Атрибут Описание
id Идентификатор запрашиваемой рассылки
from_email Адрес отправителя
from_name Имя отправителя
html HTML версия письма
text Текстовая версия письма
state Статус
recipients_count Количество получателей
purchase Информация о тарификации
statistics Статистика рассылки

Статусы рассылки

Значение Описание
draft Черновик
pending На модерации
delayed Запланированная
sending Отправляется
canceled Отменена
stopped Остановлена
completed Завершена
archived В архиве

Информация о тарификации

Атрибут Описание
enable Может принимать значение true (отправка возможна) или false (необходимо улучшить тариф)
subscribers Количество подписчиков которое будет списано из тарифа
credits Количество писем которое будет списано из тарифа
deficit Число на которое необходимо увеличить количество подписчиков или писем в тарифе

Статистика

Атрибут Описание
delivered Количество доставленных сообщений
bounced Количество недоставленный сообщений
delivering Количество доставляющихся сообщений
uniq_open Количество уникальных открытий
total_open Количество открытий всего
last_open_at Timestamp последнего открытия
uniq_click Количество уникальных переходов
total_click Количество переходов всего
last_click_at Timestamp последнего перехода
unsubscription Количество отписок
spam Количество нажатий кнопки "спам"
Мы используем cookies, чтобы сайт работал лучше. Подробнее.
Согласен