Knowledgebase

Создание получателя в группе

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

{
  "email":"alice@example.org",
  "unconfirmed": true,
  "values":[
    {
      "parameter_id":"1",
      "value":"Alice"
    },
    {
      "parameter_id":"2",
      "value":"22"
    }
  ]
}

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

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

Используется метод POST и ссылка /email/lists/:id/recipients

Где id это идентификатор группы получателей

Пример ответа в случае успешного HTTP запроса:

{
  "id":1,
  "email":"alice@example.org",
  "confirmed":false,
  "list_id":1,
  "status": "active",
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    },
    {
      "value":22.0,
      "kind":"numeric",
      "parameter_id":2
    }
  ]
}

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

Параметры элементов массива значений ( values ) и их описание приведены ниже:

Описание атрибутов json ответа от сервера приведено ниже в таблице:

Пояснение атрибутов элементов массива значений ( values ) в json ответе сервера приведено в таблице ниже:

Получение информации о получателе в группе

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

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

Здесь используется метод GET и ссылка /email/lists/:list_id/recipients/:id

Где list_id это идентификатор группы получателей, а id идентификатор получателя

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

{
  "id":2,
  "email":"alice@example.org",
  "confirmed":false,
  "list_id":1,
  "status": "active",
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    },
    {
      "value":22.0,
      "kind":"numeric",
      "parameter_id":2
    }
  ]
}
 

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

Пояснение атрибутов json ответа сервера:

Пояснение атрибутов элементов массива значений ( values ) в json ответе сервера приведено ниже в таблице:

Редактирование параметров получателя в группе:

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

{
  "email":"alice@example.org",
  "values":[
    {
      "parameter_id":"1",
      "value":"Alice"
    },
    {
      "parameter_id":"2",
      "destroy":"true"
    }
  ]
}

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

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

Используется метод PATCH и ссылка /email/lists/:list_id/recipients/:id

Где list_id это идентификатор группы получателей, id это идентификатор получателя

Пример ответа в случае успешно запроса:

{
  "id":1,
  "email":"alice@example.org",
  "confirmed":true,
  "status": "active",
  "list_id":1,
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    }
  ]
}

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

Пояснение параметров элемента массива значений ( values ) в HTTP запросе приведено в таблице ниже:

Пояснение атрибутов в json ответе от сервера:

Пояснение параметров элементов массива значений ( values ) в json ответе сервера приведено ниже в таблице:

Получение списка получателей в группе

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

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

Здесь используется метод GET и ссылка /email/lists/:id/recipients

Где id это идентификатор группы получателей

Данный метод поддерживает постраничный вывод. Максимальный размер страницы ( page_size ) является 1000

Пример json ответа в случае успешного запроса:

{
  "total_count":2,
  "total_pages":1,
  "page_number":1,
  "page_size":25,
  "collection":[
    {
      "id":1,
      "email":"alice@example.org",
      "confirmed":true,
      "status": "active",
      "list_id":1,
      "values":[
        {
          "value":"Alice",
          "kind":"string",
          "parameter_id":9
        },
        {
          "value":22.0,
          "kind":"numeric",
          "parameter_id":10
        }
      ]
    },
    {
      "id":2,
      "email":"bob@example.org",
      "confirmed":true,
      "status": "active",
      "list_id":1,
      "values":[
      ]
    }
  ]
}

Пояснение параметров элементов массива получателей ( collection ) json ответа от сервера приведено ниже в таблице:

Пояснение параметров элементов массива значений ( values ) для каждого получателя:

Удаление получателя в группе

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

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

Здесь используется метод DELETE и ссылка /email/lists/:list_id/recipients/:id

Где list_id это идентификатор группы получателей, id это идентификатор получателя.

Импорт большого количества получателей в группу получателей

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

{
  "recipients":[
    {
      "email":"alice@example.org",
      "values":[
        {
          "parameter_id":"1",
          "value":"Alice"
        },
        {
          "parameter_id":"2",
          "value":"22"
        }
      ]
    },
    {
      "email":"bob@example.org",
      "values":[
        {
          "parameter_id":"1",
          "value":"Bob"
        },
        {
          "parameter_id":"2",
          "value":"11"
        }
      ]
    }
  ]
}

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

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

Здесь используется метод POST и ссылка /email/lists/:id/recipients/imports

Где id это идентификатор группы получателей

Пример json ответа в случае успешного запроса:

{
  "id":7,
  "status":"queued"
}

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

Описание параметров элементов массива получателей ( recipients ), которых необходимо импортировать представлено ниже в таблице:

Описание параметров элементов массива значений ( values ) для каждого получателя приведено ниже в таблице:

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

Поиск получателей по email адресу

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

curl -X GET https://api.msndr.net/v1/email/recipients/search?email=foo@bar.com \
     -H 'Content-Type: application/json'                                  \
     -H 'Authorization: Bearer $API_TOKEN'

Здесь используется метод GET и ссылка /email/recipients/search

Пример ответа в случае успешного HTTP запроса:

{
  "total_count": 2,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "email": "foo@bar.com",
      "recipients": [
        {
          "list_id": 1,
          "list_title": "List #1",
          "recipient_id": 1
        },
        {
          "list_id": 2,
          "list_title": "List #2",
          "recipient_id": 2
        }
      ]
    }
  ],
  "query": "test"
}

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

Ниже в таблице представлено описание параметров элементов в массиве получателей ( recipients ) в json ответе сервера:

Атрибут              Описание

email     Email адрес получателя

recipients           Массив, содержащий информацию о списках, в которых есть искомый получатель