Выгрузить данные из стоп-списка в файл

Описание

Загрузка csv-файла с данными из стоп-списка в формате md5. Для получения информации необходимо выполнить несколько запросов: выгрузку данных в файл, проверку статуса задания и загрузку файла.

Шаг 1. Выгрузка данных в файл

URL-адрес

Метод: POST

https://example.com/api/v1.1/suppresses/export

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
id	int	1	Да	Идентификатор стоп-списка
type	string	"emails" "phones" "domains" "all"	Нет	Тип контактных данных для экспорта По умолчанию — all

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 1,
    "type": "emails"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>3</id>
  <type>emails</type>
</xml>

Пример ответа

JSON

{
    "data": {
        "task_id": "c110f0-06d0-4695-9aee-a9bab742d"
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <task_id>c110f0-06d0-4695-9aee-a9bab742d</task_id>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
task_id	string	Идентификатор задания на экспорт
error	int	Код ошибки
error_text	string	Текст ошибки

Шаг 2. Проверка статуса экспорта и получение ссылки

URL-адрес

Метод: POST

https://example.com/api/v1.1/tasks/status

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
task_id	string	"c110f0-06d0-4695-9aee-a9bab742d"	Да	Идентификатор задания

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "task_id": "c110f0-06d0-4695-9aee-a9bab742d"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <task_id>c110f0-06d0-4695-9aee-a9bab742d</task_id>
</xml>

Пример ответа

JSON

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "hashed_file": "suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip",
            "is_api": true,
            "regular_file": "",
            "suppress_id": 1,
            "total": 32
        }
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <status>completed</status>
    <progress>100</progress>
    <xml>
      <hashed_file>suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip</hashed_file>
      <is_api>true</is_api>
      <regular_file></regular_file>
      <suppress_id>1</suppress_id>
      <total>32</total>
    </xml>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
status	string	Статус задания
progress	int	Прогресс выполнения
hashed_file	array	Ссылка на скачивание файла с данными в формате md5
is_api	bool	Экспорт через API
suppress_id	int	Идентификатор стоп-списка
total	int	Количество контактов в стоп-списке
error	int	Код ошибки
error_text	string	Текст ошибки

Шаг 3. Загрузка результата

Ссылка на загрузку файла выглядит подобным образом:

https://example.com/api/download/suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip?token=abcdefghijklmnqrstuvwxyz

• https://example.com — ссылка на панель управления платформой
• api/download/suppress/b5bb73d7-530d-4a64-89d4-8ad22bad73/suppress_list_name.md5.zip — ссылка из параметра urls прошлого запроса
• ?token=abcdefghijklmnqrstuvwxyz — API-токен пользователя (после знака равенства).

Для загрузки файла с профилями необходимо либо открыть получившуюся ссылку в браузере, либо отправить пустой GET запрос с указанием данной ссылки в URL.