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