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