API и вебхуки: как передавать данные между Calltouch и другими системами
Для чего нужны API и вебхуки
API и вебхуки помогают автоматизировать обмен данными между Calltouch и внешними системами.
С их помощью Calltouch может передавать во внешние системы звонки, заявки, чаты и подробную информацию по ним: контакты клиента, источники обращений, данные сессии, теги, комментарии и другие параметры.
Внешние системы, в свою очередь, могут передавать в Calltouch данные о расходах, клиентах и сделках: выручку, статусы, даты продаж, ответственных и другие параметры. Дополнительную информацию, важную для вашего бизнеса, можно передавать с помощью пользовательских полей.
Такой обмен помогает быстрее передавать лиды в работу, отслеживать путь от обращения до сделки и понимать, какие рекламные источники приводят качественные лиды и выручку. На основе этой информации можно оптимизировать рекламные затраты, строить сквозную аналитику, отчёты, пользовательские метрики и персонализированные дашборды под задачи бизнеса.
API
Что такое API
API — это способ, с помощью которого одна система может обратиться к другой системе, чтобы получить, передать или изменить данные.
API работает по принципу «запрос — ответ»:
API удобно использовать, когда внешняя система должна сама обращаться к Calltouch: получать данные по запросу, загружать данные в Calltouch или обновлять уже существующие данные.
Например, CRM может запросить у Calltouch список звонков за нужный период. Или, наоборот, передать в Calltouch данные по сделкам, чтобы связать обращения с продажами и использовать эти данные в журналах, отчетах, сквозной аналитике, пользовательских метриках и дашбордах.
Что можно делать через API
API позволяет работать с разными сущностями Calltouch:
- звонками — выгружать журнал звонков, получать записи разговоров, импортировать звонки;
- заявками — выгружать журнал заявок, передавать заявки с сайта, импортировать заявки;
- сделками — создавать, обновлять, удалять, искать и выгружать сделки;
- клиентами — выгружать и импортировать данные по клиентам;
- параметрами лидов — добавлять и снимать теги, комментарии, ответственных и пользовательские поля;
- расходами и плановыми метриками — импортировать данные для аналитики и отчетов;
- телефонией — получать данные по подменным номерам, сценариям переадресации, пулам номеров и шаблонам подмены;
- CDP-платформой — передавать пользовательские события, работать со скорингом и статистикой.
На практике API используют для разных интеграционных сценариев: передачи сделок из CRM, импорта заявок с сайта, работы со звонками, загрузки расходов, получения записей разговоров и других задач.
В зависимости от ваших задач можно использовать разные API-методы и выстраивать логику обмена данными так, как нужно именно вашему бизнес-процессу.
Полный список API-методов, параметры запросов и примеры использования доступны в разделе: API Calltouch.
Вебхуки
Что такое вебхуки
Вебхук — это автоматическая отправка данных из Calltouch во внешнюю систему по выбранным событиям.
Вебхуки удобно использовать, когда нужно передавать данные во внешнюю систему сразу после звонка, заявки, чата или другого события.
Например, клиент позвонил, оставил заявку или написал в чат. Calltouch зафиксировал обращение и сразу отправил данные в CRM или другую внешнюю систему.
Что можно делать через вебхуки
Через вебхуки можно передавать данные по разным сущностям Calltouch:
- лидам — отправлять данные по звонкам и заявкам при начале или завершении звонка, создании заявки, изменении статуса звонка, тегов, комментариев, ответственного, рейтинга или пользовательского поля;
- сделкам — отправлять данные при создании сделки, изменении статуса, тега, источника, ответственного или пользовательского поля;
- чатам — отправлять данные по диалогам и обращениям в онлайн-чате: при отправке формы контактов, создании или удалении сообщения, начале или завершении диалога, привязке оператора.
- CDP-сценариям — отправлять данные по событиям триггерных сценариев.
Вместе с событием Calltouch может передавать подробную информацию о звонке, заявке, сделке или чате: идентификаторы, контакты клиента, источники, данные сессии, теги, комментарии, ответственных и другие параметры. Набор передаваемых полей зависит от типа вебхука и выбранных настроек. По умолчанию передаются все параметры, но лишние можно отключить.
На практике вебхуки используют, чтобы быстро передавать во внешние системы новые обращения и важные изменения. Например, с их помощью можно создавать или обновлять лиды, сделки и задачи в CRM, дополнять карточки клиентов данными об источниках обращений, тегах, комментариях и других параметрах из Calltouch. Также вебхуки подходят для передачи доступных параметров во внешние системы: для обогащения данных, отслеживания конверсий и других задач.
Вебхуки можно гибко настроить под ваши задачи: выбрать нужные события, параметры и условия отправки.
Подробные инструкции:
Чем API отличается от вебхуков
API и вебхуки решают разные задачи. API используют, когда внешняя система должна сама обратиться к Calltouch. Вебхуки используют, когда Calltouch должен сам отправить данные во внешнюю систему после наступления выбранного события.
| Критерий | API | Вебхуки |
| Кто начинает обмен | Внешняя система сама обращается к Calltouch | Calltouch сам отправляет данные во внешнюю систему |
| Когда работает | По запросу от внешней системы | При наступлении выбранного события в Calltouch |
| Для чего подходит | Для получения, загрузки и обновления данных | Для быстрой передачи данных по событиям |
| Пример | CRM запрашивает все звонки за период | Calltouch отправляет данные о новом звонке в CRM после его завершения |
API и вебхуки не заменяют друг друга: каждый инструмент используется для своих задач. В большинстве интеграций их применяют вместе.
Например, вебхуки могут передавать данные по событиям из Calltouch во внешнюю систему, а API — использоваться для загрузки или обновления данных в Calltouch.
Как API и вебхуки помогают в интеграции с CRM
API и вебхуки полезны для связи Calltouch с CRM: с их помощью данные по звонкам, заявкам и чатам можно передавать в CRM, а данные по сделкам — возвращать обратно в Calltouch для аналитики.
Один из вариантов подобной интеграции выглядит так:
В такой схеме вебхуки отвечают за передачу обращений из Calltouch в CRM: звонков, заявок, чатов и связанных с ними данных. Это помогает быстрее передавать лиды в работу и обогащать карточки клиентов, лиды или сделки в CRM данными, которые определяет Calltouch.
CRM, в свою очередь, передаёт по API данные по сделкам обратно в Calltouch: статусы, суммы продаж, даты, ответственных и другие параметры. Это помогает связать сделки с обращениями и использовать данные из CRM в отчёте сквозной аналитики и персонализированных дашбордах.
В результате обращения из Calltouch и сделки из CRM связываются между собой, а в отчётах можно оценивать, какие рекламные каналы приводят качественные лиды и сделки.