База знаний

Создание рассылки
 
 
Пример json данных для HTTP запроса:

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

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

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

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

curl -X POST https://api.msndr.net/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
 

Здесь используется метод POST и ссылка /email/campaigns
 
Пример ответа в случае успешного запроса:

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

 
 
Поясним параметры json данных в HTTP запросе в таблице ниже:

Пояснение параметров элементов массива групп получателей ( list ) :

 Поясним параметры json ответа сервера ниже в таблице:

Список статусов какие бывают приведён в таблице ниже:

Информация о тарификации ( purchase ) следующая:  

Информация о статистике ( statistics )  бывает следующая: 

Отправка созданной рассылки
 
Пример HTTP запроса:

curl -X PATCH https://api.msndr.net/v1/email/campaigns/1/deliver \
     -H 'Content-Type: application/json'                    \
     -H 'Authorization: Bearer $API_TOKEN'

 
Здесь используется метод PATCH и ссылка /email/campaigns/:id/deliver
 
Где id это идентификационный номер созданной рассылки выше.
Пример ответа в случае успешного запроса:

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

 
Поясним параметры json данных ответа сервера в таблице ниже:

Какие бывают статусы (state  ) представлено в таблице: 

Информация о тарификации ( purchase ) бывает следующей: 

Информация о статистике ( statistics  ) бывает следующей:

Получение списка рассылок
 
Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/campaigns \
     -H 'Content-Type: application/json'        \
     -H 'Authorization: Bearer $API_TOKEN'

 
Здесь используется метод GET и ссылка /email/campaigns
Данный метод поддерживает постраничный вывод
Пример ответа в случае успешного запроса:

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

Ответ от сервера является json данные в которых есть массив рассылок ( collection ) . Подробнее об элементах этого массива вы можете почитать в пункте 10.1 создание рассылки.

Получение информации об отправленной рассылке
 
Пример HTTP запроса:

curl -X GET https://api.msndr.net/v1/email/campaigns/1 \
     -H 'Content-Type: application/json'               \
     -H 'Authorization: Bearer $API_TOKEN'
 

Здесь используется метод GET и ссылка /email/campaigns/:id
 
Где id это идентификатор рассылки
 
Пример ответа в случае успешного запроса:

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

Поясним параметры json ответа сервера в таблице ниже:

Существуют следующие статусы ( state ) у рассылки: 

Также есть следующая информация о тарификации ( purchase ):

Также есть следующая информация о статистике ( statistics ):