Перейти к основному содержимому

Как отправить рассылку через Sendsay API

Sendsay API позволяет отправлять массовые и транзакционные рассылки, смотреть статистику и многое другое — с его помощью можно задать автоматизированные настройки ко всем функциям Sendsay.

Транзакционные рассылки​

Отправка через API-консоль в Sendsay​

Чтобы отправить транзакционную рассылку с помощью API в интерфейсе Sendsay:

  1. В меню аккаунта перейдите в раздел Настройки системы → Отправители и добавьте имя и адрес отправителя писем.

    Как добавить и подтвердить отправителя писем

  2. Если вы ещё не отправляли рассылки с текущего аккаунта, , чтобы вам открыли доступ на отправку транзакционных писем через API.

  3. Перейдите в раздел API → API-консоль:

    API-console

    Чтобы протестировать отправку писем, введите запрос:

    {
        "action": "issue.send",
        "letter": {
            "message": {
                "html" : "html-версия письма"
            },
            "subject": "Тема письма",
            "from.email": "EMAIL-АДРЕС ОТПРАВИТЕЛЯ"
        },
        "group": "personal",
        "email": "EMAIL-АДРЕС ПОЛУЧАТЕЛЯ",
        "sendwhen": "now"
    }

    где EMAIL-АДРЕС ОТПРАВИТЕЛЯ — email-адрес, который вы добавили в качестве отправителя, а EMAIL-АДРЕС ПОЛУЧАТЕЛЯ — ваш email-адрес, на который уйдёт тестовое письмо.

    Нажмите «Выполнить». После этого на email-адрес получателя отправится письмо, а в разделе Статистика → Транзакционные рассылки появятся данные об успешной отправке:

    Statistics

Отправка через Postman​

Протестируйте отправку запроса извне — например, через Postman. Для этого вам потребуется уникальный API-ключ.

Как получить API-ключ

  1. Перейдите в Postman и авторизуйтесь, либо зарегистрируйте новый аккаунт. В разделе My Workspace нажмите «New» и выберите HTTP — чтобы создать новый HTTP-запрос:

    Postman

  2. В параметрах запроса выберите метод POST. Затем во вкладке body укажите raw, а в раскрывающемся меню выберите JSON:

    Postman

  3. В поле URL вставьте https://api.sendsay.ru/general/api/v100/json/Ваш_логин_Sendsay. Вместо Ваш_логин_Sendsay необходимо добавить ваш логин, его можно скопировать в меню аккаунта:

Login

  1. В поле ниже вставьте запрос:

    {
       "action": "issue.send",
       "letter": {
           "message": {
               "html" : "html-версия письма"
           },
           "subject": "Тема письма",
           "from.email": "EMAIL-АДРЕС ОТПРАВИТЕЛЯ"
       },
       "group": "personal",
       "email": "EMAIL-АДРЕС ПОЛУЧАТЕЛЯ",
       "sendwhen": "now",
       "apikey": "ВАШ API КЛЮЧ"
    }

    где EMAIL-АДРЕС ОТПРАВИТЕЛЯ — адрес отправителя, который вы добавили в п.1; EMAIL-АДРЕС ПОЛУЧАТЕЛЯ — ваш email-адрес, на который отправится тестовое письмо; ВАШ API КЛЮЧ — API-ключ, который был сгенерирован в п.4.

    Затем нажмите «Send».

    После отправки запроса должен прийти похожий ответ:

    Postman

    Это значит, что запрос выполнился успешно, и письмо отправлено. В разделе Статистика → Транзакционные выпуски можно увидеть информацию об отправленном выпуске.

Массовые рассылки через Sendsay API​

Данные для выпуска можно передавать как в API-запросе, так и использовать заранее подготовленные шаблон выпуска и список или сегмент получателей. В первом случае используйте обычный массовый выпуск, во втором — экспресс-выпуск.

Обычный массовый выпуск​

Если с помощью API нужно отправить рассылку, для которой у вас в аккаунте уже созданы черновик и список будущих получателей, укажите их ID в API-запросе:

{
    "action": "issue.send",
    "group": "GROUPID",
    "sendwhen": "now",
    "letter": {
        "draft.id": "DRAFTID"
    }
}

где GROUPID — ID списка или сегмента получателей, а DRAFTID — ID шаблона выпуска.

Экспресс-выпуск​

Если нужно передать список участников в запросе, используйте экспресс-выпуск.

Содержимое письма можно взять из шаблона выпуска, а вот список или сегмент получателей нужно подготовить в CSV или JSON в соответствии с документацией.

Важно

Адреса, по которым вы хотите отправить рассылку, должны находиться в базе и быть доступными для рассылок.

В API-консоли введите запрос:

{
    "action": "issue.send",
    "group": "masssending",
    "sendwhen": "now",
    "letter": {
        "draft.id": "DRAFTID"
    },
    "users.list": "member.email;data.name\nask@sendsay.ru;Андрей"
}

где DRAFTID — ID шаблона выпуска, member.email;data.name\nask@sendsay.ru;Андрей — адреса и данные получателей, непосредственно в JSON или СSV.