Contacts API
- Oleksandr Serdiuk
- Dmytro Lytvyn
С помощью данного API вы можете просматривать, находить, добавлять, редактировать, объединять и удалять контакты в проекте.
Получение.
Позволяет получать список контактов в проекте.
GET https://api.smartsender.com/v1/contacts
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
{
"cursor": Cursor,
"collection": Contact[]
}
Описание ответа:
Поиск.
Позволяет найти совпадения по контактам с помощью ключевого слова.
GET https://api.smartsender.com/v1/contacts/search
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
term | Ключевое слово для поиска | Не пустое |
В случае успешного ответа получите следующее:
Описание ответа:
Поиск по ID.
Получение информации о контакте по идентификатору.
В случае успешного ответа получите объект типа Contact.
Поиск по ID (простой).
Получение информации об контакте по идентификатору.
В случае успешного ответа получите объект типа Contact.
В данном методе переменные будет переданы как ключ-значение без детальной информации о самих переменных.
Поиск чата по ID.
Получение чата контакта по идентификатору.
В случае успешного ответа получите объект типа Chat.
Поиск доступных коммуникаций по ID.
Получение списка доступных коммуникаций контакта по идентификатору.
Основные параметры:
Название | Описание | Валидация |
|---|---|---|
page | Запрашиваемая страница | Минимальное значение 1 |
limitation | Количество данных для вывода на странице | Минимальное значение 1, максимальное 20 |
В случае успешного ответа получите следующее:
Описание ответа:
Обновление.
Обновляет данные выбранного клиента.
Основные параметры: Укажите все необходимые параметры для обновления в теле запроса. Это могут быть как и переменные, так и системные поля.
Основные параметры:
Название | Тип | Описание |
|---|---|---|
values | Объект (ключ-значение) | Все необходимые параметры для обновления в теле запроса. Это могут быть как и переменные, так и системные поля. |
Важно! Если указано не верное значение для обновления поля, поле будет пропущено и остальное обновление будет обработано.
В случае успешного ответа получите следующее:
Запуск события.
Запускает выбранное событие для контакта.
Основные параметры:
Название | Описание |
|---|---|
name | Название события, регистр имеет значение |
В случае успешного ответа получите следующее:
Обьединение.
Объединяет одного клиента с другим. Все теги, воронки, переменные будет синхронизированы в пользу {contactId}, а все недостающие значения будут взяты из {targetContactId}.
В случае успешного ответа получите следующее:
(DEPRECATED) Удаление.
Позволяет удалить выбранного контакта.
В случае успешного ответа получите следующее:
Создание.
Создание контакта доступно только для платформы Smart Messenger с использованием Channels API (создание шлюза). Для этого Вам необходим идентификатор канала.