Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

За допомогою цього API можна переглядати, знаходити, додавати, редагувати, об'єднувати та видаляти контакти в проекті.

Отримання.

Дозволяє отримувати список контактів у проекті.

 

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

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

Назва

Опис

Валідація

page

Запрошувана сторінка

Мінімальне значення 1

limitation

Кількість даних для виводу на сторінці

Мінімальне значення 1, максимальне 20

 
У разі успішної відповіді отримаєте таке:

 

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


Опис відповіді:

Назва

Опис

cursor

Об'єкт типу Cursor

collection

Масив об'єктів типу Contact

 

Пошук.

Дозволяє знайти збіги контактів за допомогою ключового слова.

 

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

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

Назва

Опис

Валідація

page

Запрошувана сторінка

Мінімальне значення 1

limitation

Кількість даних для виводу на сторінці

Мінімальне значення 1, максимальне 20

term

Ключове слово для пошуку

Не пусте

 
У разі успішної відповіді отримаєте таке:

 

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


Опис відповіді:

Назва

Опис

cursor

Об'єкт типу Cursor

collection

Масив об'єктів типу Contact

 

Пошук за ID.

Отримання інформації про контакт за ідентифікатором.

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

 
У разі успішної відповіді отримайте об'єкт типу Contact

 

Пошук за ID (простий).

Отримання інформації про контакт за ідентифікатором.

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

 
У разі успішної відповіді отримайте об'єкт типу Contact

У цьому методі змінні будуть передані як ключ-значення без детальної інформації про самих змінних.

 

Пошук чату за ID.

Отримання контакту чату за ідентифікатором.

 

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

 
У разі успішної відповіді отримайте об'єкт типу Chat.

 

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

Отримання списку доступних комунікацій контакту за ідентифікатором.

 

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

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

Назва

Опис

Валідація

page

Запрошувана сторінка

Мінімальне значення 1

limitation

Кількість даних для виводу на сторінці

Мінімальне значення 1, максимальне 20

 
У разі успішної відповіді отримаєте таке:

 

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


Опис відповіді:

Назва

Опис

cursor

Об'єкт типу Cursor

collection

Масив об'єктів типу Gate

 

Оновлення.

Оновлює дані вибраного клієнта.

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

 
Основні параметри: Вкажіть усі необхідні параметри, щоб оновити запит. Це може бути як і змінні, і системні поля.


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

Назва

Тип

Опис

values

Об'єкт (ключ-значення)

Усі необхідні параметри для оновлення запиту. Це може бути як і змінні, і системні поля.

 

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

У разі успішної відповіді отримаєте таке:

 

{
    "state": true
}

 

Запуск події.

Запускає вибрану подію для контакту.

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

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

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

Назва

Опис

name

Назва події, регістр має значення

 

У разі успішної відповіді отримаєте таке:

 

{
    "state": true
}

 

Об'єднання.

Поєднує одного клієнта з іншим. Всі теги, вирви, змінні будуть синхронізовані на користь {contactId}, а всі значення, що відсутня, будуть взяті з {targetContactId}.

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

 

У разі успішної відповіді отримаєте таке:

{
    "state": true
}

 

(DEPRECATED) Видалення.

Дозволяє видалити вибраний контакт.

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

 

У разі успішної відповіді отримаєте таке:

 

{
    "state": true
}

 

  • No labels