API для SMTP сервиса

Отправить письмо

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

https://api.sendpulse.com/smtp/emails

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

Параметры массива письма:

Пример запроса с отправкой своего шаблона:

{
  "email": {
    "html": "PHA+RXhhbXBsZSB0ZXh0PC9wPg==", 
    "text": "Example text",
    "subject": "Example subject",
    "from": {
      "name": "Example name",
      "email": "sender@example.com"
    },
    "to": [
      {
        "name": "Recipient1 name",
        "email": "recipient1@example.com"
      }
    ]
  }
}

Пример запроса с отправкой письма по шаблону сервиса c кастомными переменными:

{
  "email": {
    "subject": "Test",
    "template": {
      "id": 123456,
      "variables": {
        "name": "Владислав",
        "code": "123456"
      }
    },
    "from": {
      "name": "Mike",
      "email": "mike.johnson@domain.com"
    },
    "to": [
      {
        "email": "recipient1@example.com",
        "name": "Владислав"
      }
    ]
  }
}

В данном примере вместо параметров html и text используется параметр template.

Пример запроса с отправкой копий письма:

{
  "email": {
    "html":"dGVzdCBBUEk=",
    "text": "text",
    "subject": "subject",
    "from": {
      "name": "test",
      "email": "test@test.com"
    },
    "to": [
      {
        "name": "recipient 1",
        "email": "recipient1@test.com"
      }
    ],
    "cc":[
      {
         "name":"recipient 2",
         "email":"recipient2@test.com" 
      }
    ],
    "bcc":[
      {
         "name":"recipient 3",
         "email":"recipient3@test.com" 
      }
    ]
  }
}

В случае успешного запроса вы получите ответ:

{
    "result": true,
    "id": "pzkic9-0afezp-fc" // ID отправленного письма
}

Получить список писем

Чтобы получить список всех отправленных писем, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/emails

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

В случае успешного запроса вы получите ответ:

   {
        "id": "pzkic9-0afezp-fc",
        "sender": "tech@yourdream.com",
        "total_size": 1175,
        "sender_ip": "173.212.198.158",
        "smtp_answer_code": 250,
        "smtp_answer_code_explain": "Delivered",
        "smtp_answer_subcode": "",
        "smtp_answer_data": "anna-maria@gmail.com   H=gmail-smtp-in.l.google.com [64.233.165.27] X=TLSv1.2:ECDHE-RSA-CHACHA20-POLY1305:256 CV=yes K C=\"250 2.0.0 OK s129-v6si13409556lja.72 - gsmtp\"",
        "used_ip": "78.41.200.153",
        "recipient": "anna-maria@gmail.com",
        "subject": "Template test",
        "send_date": "2018-10-10 12:54:45",
        "tracking": {
            "click": 1,
            "open": 1,
            "link": [
                {
                    "url": "wikia.com",
                    "browser": "Firefox 64.0",
                    "os": "Linux",
                    "screen_resolution": "1920x1080",
                    "ip": "77.222.152.150",
                    "action_date": "2018-12-12 11:54:55"
                }
            ],
            "client_info": [
                {
                    "browser": "Firefox 11.0viaggpht.comGoog",
                    "os": "Windows",
                    "ip": "66.102.9.17",
                    "action_date": "2018-12-12 11:54:54"
                }
            ]
        }
    }

Получить общее количество отправленных писем

Чтобы получить общее количество отправленных писем, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/emails/total

В случае успешного запроса вы получите ответ:

{
    "total": 25408
}

Получить информацию по конкретному письму

Чтобы получить информации по конкретному письму, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/emails/{id}

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

В случае успешного запроса вы получите ответ:

{
  "id": "pzkic9-0afezp-fc",
  "sender": "JohnDoe@test.com",
  "total_size": 1128,
  "sender_ip": "127.0.0.1",
  "smtp_answer_code": 250,
  "smtp_answer_subcode": "0",
  "smtp_answer_data": "Bad recipients",
  "used_ip": "5.104.224.87",
  "recipient": null,
  "subject": "SendPulse :: Email confirmation",
  "send_date": "2013-12-17 10:33:53",
  "tracking": {
    "click": 1,
    "open": 1,
    "link": [
      {
	"url": "http://some-url.com",
	"browser": "Chrome 29.0.1547.57",
	"os": "Linux",
	"screen_resolution": "1920x1080",
	"ip": "46.149.83.86",
	"country": "Ukraine",
	"action_date": "2013-09-30 11:27:40"
      }
    ],
    "client_info": [
      {
	"browser": "Thunderbird 17.0.8",
	"os": "Linux",
	"ip": "46.149.83.86",
	"country": "Ukraine",
	"action_date": "2013-09-30 11:27:49"
      }
    ]
  }
} 

Получить информацию по списку писем

Чтобы получить информацию по списку писем, отправьте POST запрос по ссылке:

https://api.sendpulse.com/smtp/emails/info

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

Получить список баунсов за сутки

Чтобы получить список баунсов за сутки, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/bounces/day

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

Пример URL, который получить 10 записей начиная с 20:

https://api.sendpulse.com/smtp/bounces/day?limit=10&offset=20

Баунсы получаются только за сутки, начиная с текущего момента. Например сегодня - 2016-04-28 14:34:00, следовательно записи будут получены за период с 2016-04-27 14:34:00 по 2016-04-28 14:34:00

Пример ответа баунсов на определенный день:

{
    "total": 2,
    "emails": [
        {
            "email_to": "gverb2016@yandex.ru",
            "sender": "no-reply@boomstream.com",
            "send_date": "2019-03-25 19:05:02",
            "subject": "[Boomstream] Покупка доступа к видео контенту",
            "smtp_answer_code": 550,
            "smtp_answer_subcode": "5.1.1",
            "smtp_answer_data": "gverb2016@yandex.ru   H=mx.yandex.ru [93.158.134.89] X=TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128 CV=yes: SMTP error from remote mail server after RCPT TO:<gverb2016@yandex.ru>: 550 5.7.1 No such user!"
        },
        {
            "email_to": "1934a1a621@mailboxy.fun",
            "sender": "no-reply@boomstream.com",
            "send_date": "2019-03-25 15:58:00",
            "subject": "Your video files has been deleted",
            "smtp_answer_code": 552,
            "smtp_answer_subcode": "5.7.1",
            "smtp_answer_data": "1934a1a621@mailboxy.fun   H=mx5.mailboxy.fun [165.227.245.168] X=TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128 CV=no: SMTP error from remote mail server after RCPT TO:<1934a1a621@mailboxy.fun>: 552 Mailbox limit exeeded for this email address"
        }
    ],
    "request_limit": 1000,
    "found": 2
}

Получить общее количество баунсов

Чтобы получить отбщее количество баунсов, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/bounces/day/total

В случае успешного запроса вы получите ответ:

{
    "total": 3
}

Отписать получателя

Чтобы отписать подписчика от получения рассылки, отправьте POST запрос по ссылке:

https://api.sendpulse.com/smtp/unsubscribe

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

Пример структуры массива emails:

[
  {
    "email": "badUser1@mailserver.com",
    "comment": "comment1"
  },
  {
    "email": "badUser2@mailserver.com",
    "comment": "comment2"
  }
]

В случае успешного запроса вы получите ответ:

{
   "result": true
}

Удалить из списка отписавшихся

Чтобы удалить подписчика, который отказался получать рассылку, из списка отписавшихся, отправьте DELETE запрос по ссылке:

https://api.sendpulse.com/smtp/unsubscribe

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

В случае успешного запроса вы получите ответ:

{
   "result": true
}

Получить список отписавшихся

Чтобы получить список отписавшихся, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/unsubscribe

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

Пример URL, который получить 10 записей начиная с 20:

https://api.sendpulse.com/smtp/unsubscribe?limit=10&offset=20

Если указано date, то выгрузка будет за 1 день. Пример URL с датой:

https://api.sendpulse.com/smtp/unsubscribe?date=2016-03-05

В случае успешного запроса вы получите ответ:

[  
   {  
      "email":"4090797@mail.ru",
      "unsubscribe_by_link":1,
      "unsubscribe_by_user":0,
      "spam_complaint":1,
      "date":"2018-11-24 19:19:01"
   },
   {  
      "email":"4lik@rambler.ru",
      "unsubscribe_by_link":1,
      "unsubscribe_by_user":0,
      "spam_complaint":1,
      "date":"2019-03-20 16:47:01"
   }
]

Заново подписать получателя

Чтобы отправить контакту письмо для повторной подписки на получение уведомлений, отправьте POST запрос по ссылке:

https://api.sendpulse.com/smtp/resubscribe

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

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

{
    "email":"test@test.com",
    "sender":"my_sender@test.com",
    "lang":"en"
}

В случае успешного запроса вы получите ответ:

{
    "result": true,
    "id": "pzkic9-0afezp-fc"  // ID отправленного письма
}

Получить список IP-адресов отправителя

Чтобы получить список IP-адресов отправителя, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/ips

В случае успешного запроса вы получите ответ:

[
  "127.0.0.1"
]

Получить список адресов отправителя

Чтобы получить список всех отправителей в SMTP сервисе, отправьте GET запрос по ссылке:

https://api.sendpulse.com/smtp/senders

В случае успешного запроса вы получите ответ:

[
    "sender@domain.com"
]

Получить список разрешенных доменов

Чтобы получить список разрешенных доменов,  отправьте GET запрос по ссылке:

https://api.sendpulse.com/v2/email-service/smtp/sender_domains

Обратите внимание, что 17.05.2023 изменилась ссылка на получение списка разрешенных доменов для отправки.

В случае успешного запроса вы получите ответ:

{
   "data":{
      "result":true,
      "data":[
         {
            "id":37857,
            "user_id":7043663,
            "service_type":3,
            "service_value":"example.com",
            "status":0,
            "expire_date":null,
            "auto_free_prolong":0,
            "currency":"",
            "is_default":true,
            "ssl_type":0,
            "ssl_expired":null,
            "ssl_generated":null,
            "checks":{
               "check_dkim":false,
               "check_spf":false,
               "check_dmarc":false,
               "all_checks":false,
               "spf_txt_needed":"v=spf1 include:mxsspf.sendpulse.com +a +mx -all"
            }
         }
      ]
   }
}

Параметры ответа:

Добавить отправителя

Чтобы добавить отправителя, отправьте POST запрос по ссылке:

https://api.sendpulse.com/senders

Адреса отправителей для Email и SMTP сервиса объеденины. Адресам, которые вы будете добавлять после 17.05.2023 в Email сервис, будут также доступны для отправки и в SMTP сервисе.

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

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

{
   "email": "sender@example.com",
   "name": "Sender"
}

В случае успешного запроса вы получите ответ:

{
   "result": true
}

Добавить домен

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

https://api.sendpulse.com/v2/email-service/smtp/sender_domains/{{mydomain.com}}

Обратите внимание, что 17.05.2023 изменилась ссылка на добавление доменов для отправки. Также был удален метод верификации домена.

Параметр запроса в URL:

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

https://api.sendpulse.com/v2/email-service/smtp/sender_domains/mydomain.com

В случае успешного запроса вы получите ответ:

{
   "data":{
      "result":true,
      "error":null
   }
}