Contacts API

С помощью данного API вы можете просматривать, находить, добавлять, редактировать, объединять и удалять контакты в проекте.

Получение.

Позволяет получать список контактов в проекте.

GET https://api.smartsender.eu/v1/contacts

Основные параметры:

Название	Описание	Валидация
page	Запрашиваемая страница	Минимальное значение 1
limitation	Количество данных для вывода на странице	Минимальное значение 1, максимальное 20

В случае успешного ответа получите следующее:

{
    "cursor": Cursor,
    "collection": Contact[]
}

Описание ответа:

Название	Описание
cursor	Объект типа Cursor
collection	Массив объектов типа Contact

Поиск.

Позволяет найти совпадения по контактам с помощью ключевого слова.

GET https://api.smartsender.eu/v1/contacts/search

Основные параметры:

Название	Описание	Валидация
page	Запрашиваемая страница	Минимальное значение 1
limitation	Количество данных для вывода на странице	Минимальное значение 1, максимальное 20
term	Ключевое слово для поиска	Не пустое

В случае успешного ответа получите следующее:

{
    "cursor": Cursor,
    "collection": Contact[]
}

Описание ответа:

Название	Описание
cursor	Объект типа Cursor
collection	Массив объектов типа Contact

Поиск по ID.

Получение информации об контакта по идентификатору.

GET https://api.smartsender.eu/v1/contacts/{contactId}

В случае успешного ответа получите объект типа Contact.

Поиск чата по ID.

Получение чата контакта по идентификатору.

GET https://api.smartsender.eu/v1/contacts/{contactId}/chat

В случае успешного ответа получите объект типа Chat.

Поиск доступных коммуникаций по ID.

Получение списка доступных коммуникаций контакта по идентификатору.

GET https://api.smartsender.eu/v1/contacts/{contactId}/gates

Основные параметры:

Название	Описание	Валидация
page	Запрашиваемая страница	Минимальное значение 1
limitation	Количество данных для вывода на странице	Минимальное значение 1, максимальное 20

В случае успешного ответа получите следующее:

{
    "cursor": Cursor,
    "collection": Gate[]
}

Описание ответа:

Название	Описание
cursor	Объект типа Cursor
collection	Массив объектов типа Gate

Обновление.

Обновляет данные выбранного клиента.

PUT https://api.smartsender.eu/v1/contacts/{contactId}

Основные параметры: Укажите все необходимые параметры для обновления в теле запроса. Это могут быть как и переменные, так и системные поля.

Основные параметры:

Название	Описание
values	Все необходимые параметры для обновления в теле запроса. Это могут быть как и переменные, так и системные поля.

Важно! Если указано не верное значение для обновления поля, поле будет пропущено и остальное обновление будет обработано.

В случае успешного ответа получите следующее:

{
    "state": true
}

Запуск события.

Запускает выбранное событие для контакта.

POST https://api.smartsender.eu/v1/contacts/{contactId}/fire

Основные параметры:

Название	Описание
name	Название события, регистр имеет значение

В случае успешного ответа получите следующее:

{
    "state": true
}

Обьединение.

Объединяет одного клиента с другим. Все теги, воронки, переменные будет синхронизированы в пользу {contactId}, а все недостающие значения будут взяты из {targetContactId}.

POST https://api.smartsender.eu/v1/contacts/{contactId}/unite/{targetContactId}

В случае успешного ответа получите следующее:

{
    "state": true
}

Удаление.

Позволяет удалить выбранного контакта.

DELETE https://api.smartsender.eu/v1/contacts/{contactId}

В случае успешного ответа получите следующее:

{
    "state": true
}