Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
indent20px
printablefalse

Описание

Выгружает csv файл с данными из стоп-списка в формате md5.

Состоит из 3 запросов.

1 - выгрузка данных в файл

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
idint1ДаИдентификатор стоп-списка
typestring

"emails"

"phones"

"domains"

"all"

Нет

Тип контактных данных для экспорта

По умолчанию — all


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

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

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

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

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

ПараметрТипОписание
task_idstringИдентификатор задания на экспорт
errorintКод ошибки
error_textstringТекст ошибки


2 - проверка статуса экспорта и получение ссылки

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
task_idstring

"c110f0-06d0-4695-9aee-a9bab742d"

ДаИдентификатор задания


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

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

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

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

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

ПараметрТипОписание
statusstringСтатус задания
progressintПрогресс выполнения
hashed_filearrayСсылка на скачивание файла с данными в формате md5
is_apiboolЭкспорт через API
suppress_idintИдентификатор стоп-списка
totalintКоличество контактов в стоп-списке
errorintКод ошибки
error_textstringТекст ошибки


3 - скачивание результата

URL-адрес

Метод: GET

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

...