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

Описание

Загрузка CSV-файла с данными из стоп-списка в формате MD5. Для получения результата нужно получить статус задачи и выгрузить итоговый файл.

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

URL-адрес

Метод: POST

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

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

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

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

JSON

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

XML

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

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

JSON

{
    "data": {
        "status": "completed",
        "progress": 100,
        "result": {
            "hashed_file": "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>
    <result>
      <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>
    </result>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

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

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

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

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

https://example.com/api/download/suppress/ + значение hashed_file

Например:

https://example.com/api/download/suppress/abCDefghIklMnop57498257/suppress_list_name.md5.zip

где:

• https://example.com — домен платформы
• api/download/suppress/ — фиксированный префикс для выгрузки данных стоп-списков
• abCDefghIklMnop57498257/suppress_list_name.md5.zip — значение параметра hashed_file из ответа шага 2 (зашифрованный путь и имя файла)

Запрос должен содержать заголовок авторизации Authorization: Bearer <token>.