↔️ REST API
Керуйте контактам, чатами, повідомленнями та синхронізуйте дані зі сторонніми службамиВступ
Початок роботи з REST API
Основи роботи з HelpCrunch REST API
Контакти
Модель контакту
Детальна інформація про кожне поле Customer Object
Отримати інформацію про контакт
Отримайте інформацію про контакт за його ID
Отримати всі контакти
Отримайте список усіх контактів або певної групи контактів
Пошук контактів
Знайдіть контакти за значеннями їх атрибутів
Прибрати тег контакту
Видаліть теги з профілю контакту
Додати тег контакту
Позначте один контакт тегами
Додати подію контакту
Надішліть подію активності контакту
Видалити контакт
Видаліть один контакт за його ID
Оновити групу контактів
Оновлюйте одразу кілька контактів за раз
Оновити контакт
Оновити дані вже існуючого контакту за його ID
Створити контакт
Додайте один контакт до HelpCrunch
Чати
Модель даних чату
Детальна інформація про кожне поле Chat Object
Отримати інформацію про чат
Отримайте деталі одного чату за його ID
Отримати всі чати
Отримайте список усіх чатів або певної кількості чатів
Знайти чати
Знайдіть чати за значенням їхніх атрибутів
Створити чат
Створіть один чат від імені конкретного контакту
Позначити чат як прочитаний
Позначити чати як прочитані за допомогою API
Оновити відповідальний відділ
Змінити відділ, на який призначено чат
Додати нагадування про чат / зняти нагадування
Відкладіть чат на певний день і час
Оновити відповідального за чат
Змініть оператора, на якого призначено чат
Оновити статус чату
Змініть статус будь-якого чату
Оцінка чату
Оцінюйте закриті чати за допомогою API
Повідомлення
Модель даних повідомлення
Детальна інформація про кожне поле Message Object
Створити повідомлення
Публікуйте повідомлення в будь-якому чаті від імені контакту або оператора
Отримати повідомлення чату
Отримайте всі повідомлення з будь-якого чату
Члени команди
Модель даних членів команди
Детальна інформація про кожне поле Agent Object
Отримати всіх членів команди
Отримайте список усіх членів команди для вашого облікового запису
Відписати членів команди від сповіщень
Скасуйте підписку будь-якого члену команди на розсилки HelpCrunch
Відділи
Модель даних відділу
Детальна інформація про кожне поле Department Object
Отримати всі відділи
Отримайте список усіх відділів у вашому обліковому записі
Застосунки
Модель даних застосунку
Детальна інформація про кожне поле Application Object
Отримати всі застосунки
Отримати інформацію щодо усіх веб-віджетів, застосунків iOS/Android та підключених месенджерів до вашого облікового запису
Організація
Отримати статус доступності команди
Отримати інформацію про статус вашої команди - чи вона онлайн/офлайн
Модель даних організації
Детальна інформація про кожне поле Organization Object