Page Comparison

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

...

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

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

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

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

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

Поиск.

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

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

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

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

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

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

Поиск по ID.

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

...

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

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

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

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

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

Обновление.

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

...

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

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

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

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

...

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

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

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

...

{
    "state": true
}

(DEPRECATED) Удаление.

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

...

{
    "state": true
}

Создание.

Создание контакта доступно только для платформы Smart Messenger с использованием Channels API (создание шлюза). Для этого Вам необходим идентификатор канала.