Начало работы

База знаний

Регистрация

Вход

РУ

База знаний

Регистрация

Вход

РУ

База знаний

Начало работы

Эта статья поможет узнать, какой может быть ваша интеграция и с чего начать разработку.

Определения в статье
Какие возможности даёт API Wazzup
Авторизация
Сценарии интеграции
- Для Wazzup Label
- Для White Label

Определения в статье

Клиент — конечный пользователь Wazzup, от имени которого партнер работает через API.

Аккаунт-дочка, дочерний аккаунт — аккаунт Wazzup, созданный техническим партнером для клиента.

Пользователь — это профиль сотрудника в CRM (сотрудник вашего клиента), который использует интеграцию. Например, профиль менеджера по продажам или сотрудника поддержки, который ведет сделки или работает с обращениями в CRM.

Канал — аккаунт в мессенджере или соцсети, который вы можете подключить к CRM через Wazzup.

Какие возможности даёт API Wazzup

API Wazzup — это простой способ интегрировать мессенджеры и соцсети в SaaS-сервис. Пользователи смогут переписываться в мессенджерах прямо из вашего сервиса.

Подключение мессенджеров. Вы можете поддерживать в интеграции работу с каналами одного типа или разных типов, подключать один номер или несколько. Например, подключить клиенту одновременно два номера Telegram, аккаунт Telegram Bot, номер MAX и Авито.

Переписка. API позволяет общаться через MAX и MAX-бот, Telegram и Telegram-бот, WhatsApp и WhatsApp Business API (WABA), Авито, Viber, Instagram* API.

Автоматизация. Клиенты партнеров Wazzup Label могут настроить автоответы через личный кабинет Wazzup: на первое входящее сообщение, на сообщение в нерабочее время и на пропущенный звонок.

API Wazzup не предлагает инструменты для рассылок, но вы можете настроить отправку рассылок на своей стороне с помощью подключенных каналов. Например, Telegram Bot, бота MAX или WhatsApp Business API (WABA).

Авторизация

В заголовках запросов используем два вида авторизации в зависимости от метода.

1) Basic-авторизация с кодированием вашей электронной почты и пароля, с которыми входите в личный кабинет партнёра Wazzup: Authorization: Basic base64(email:password)

Эта авторизация нужна при запросах, чтобы:

управлять аккаунтами-дочками,
получать информацию о партнерском аккаунте,
работать с лимитами и балансами WABA.

2) По токену вашего клиента client_access_token. Токен нужен, чтобы:

работать от имени клиента: подключать каналы, отправлять сообщения, управлять CRM-сущностями: контактами, воронками, сделками,
получать и обрабатывать вебхуки.

Сценарии интеграции

Ниже описаны два базовых сценария интеграции для Wazzup Label и White Label. В реальности вы можете использовать тот набор методов, инструментов, который подходит вашему клиенту.

Есть два способа работать с чатами в вашем сервисе:

либо внедрить готовое окно чатов Wazzup (iframe) со всеми привычными функциями мессенджеров;
либо самостоятельно разработать интерфейс и работать с сообщениями с помощью отдельных API-методов.

Окно чатов

Мы рекомендуем использовать наш интерфейс для чатов, потому что:

вам не нужно разрабатывать, дорабатывать, поддерживать свои интерфейсы для обработки диалогов;
мы постоянно улучшаем наш интерфейс → повышаем его удобство и ценность для пользователя. Сначала новые возможности появляются в iframe, а уже после — в API-методах;
окно Wazzup похоже на чат в мессенджере, поэтому вашим пользователям не придется привыкать к интерфейсу.

А еще у нас есть мобильное приложение, поэтому пользователи могут оставаться на связи, даже когда работают «в полях».

→ Узнать больше о чатах Wazzup

→ Узнать больше о мобильном приложении Wazzup

В описанных сценариях для переписки можно использовать встроенное окно чатов Wazzup (iframe) или методы для работы с сообщениями. Но поскольку рекомендуем работать с нашим iframe, во всех вариантах пишем про него.

Если планируете разрабатывать свой интерфейс чатов, то на разработку нужно закладывать больше времени, чем указано в сценариях.

Для Wazzup Label

На первые четыре этапа разработки уйдет два-три дня. После этого клиенты могут подключить каналы в своем личном кабинете и начать переписываться из встроенного окна чатов.

Что	Зачем
1. Получите доступ к личному кабинету партнера и `client_id`	Для этого свяжитесь с менеджером Wazzup. На следующих шагах нужен `client_id`, а также email и пароль от вашего личного кабинета.
2. Получите токен для дочернего аккаунта	Чтобы выполнять действия в аккаунте клиента: подключать каналы, отправлять сообщения и другие.
3. Настройте синхронизацию аккаунтов пользователей вашего сервиса и Wazzup	Так у нас в Wazzup будет актуальный список ваших пользователей, которые будут работать в чатах Wazzup.
4. Научитесь открывать окно чатов	Окно со всеми чатами, доступными для пользователя (`"scope": "global"`) В этом окне пользователь видит все чаты, которые ему доступны в Wazzup. Открыть окно со всеми чатами можно по кнопке. Рекомендуем разместить кнопку на видном месте, под рукой у менеджера. Окно чатов с определенным контактом (`"scope": "card"`) В этом окне отображаются доступные пользователю чаты с конкретными контактами. Например, которые указаны в карточке сделки. Рекомендуем размещать кнопку, по которой открывается окно, в сущности контакта и сделки.
5. Настройте синхронизацию контактов вашей CRM и Wazzup	Это нужно, чтобы: показывать диалоги менеджерам, которые указаны ответственными за контакт, пользователь мог быстро попадать на карточку контакта в CRM, можно было инициировать чат из карточки контакта с теми контактами, которых создали в CRM до подключения к Wazzup.
6. Настройте синхронизацию сделок из вашей CRM и Wazzup	Это нужно, чтобы: показывать диалоги менеджерам, которые указаны как ответственные за сделку, менеджер мог видеть список открытых и закрытых сделок у этого контакта, быстро попадать на карточку сделки в CRM.
7. Настройте счетчик неотвеченных	Дает понять, что остались неотвеченные сообщения. Рекомендуем его размещать на кнопке, по которой менеджер переходит в окно со всеми доступными чатами.
8. Научитесь получать и обрабатывать вебхуки	Получение новых сообщений → для использования в вашей системе нотификаций.
9. Отладьте работу со списком «Сделки»	1. Проверьте корректность передачи ссылок в `PATCH /v2/contacts` для отображения кнопки-ссылки на страницу контакта в CRM 2. Проверьте корректность передачи ссылок в `PATCH /v2/deals` для отображения ссылок на существующие сделки с данным контактом 3. Научитесь создавать новые сделки при клике пользователем на + в дропдауне «Сделки» по событию. Пока что вебхуки о создании сделки и контакта недоступны.

Для White Label

На первые семь этапов разработки уйдет несколько дней. После этого клиенты могут подключить каналы в своем личном кабинете и начать переписываться из встроенного окна чатов.

Что	Зачем
1. Получите доступ к личному кабинету партнера и `client_id`	Для этого свяжитесь с менеджером Wazzup. На следующих шагах нужен `client_id`, а также email и пароль от вашего личного кабинета.
2. Создайте аккаунт для клиента	После вы получите `account_id` клиента, который нужен для получения пользовательских токенов.
3. Получите токен для дочернего аккаунта	Чтобы выполнять действия в аккаунте клиента: подключать каналы, отправлять сообщения и другие.
4. Настройте синхронизацию аккаунтов пользователей вашего сервиса и Wazzup	Так у нас в Wazzup будет актуальный список ваших пользователей, которые будут работать в чатах Wazzup.
5. Научитесь открывать окно чатов	Окно со всеми чатами, доступными для пользователя (`"scope": "global"`) В этом окне пользователь видит все чаты, которые ему доступны в Wazzup. Открыть окно со всеми чатами можно по кнопке. Рекомендуем разместить кнопку на видном месте, под рукой у менеджера. Окно чатов с определенным контактом (`"scope": "card"`) В этом окне отображаются доступные пользователю чаты с конкретными контактами. Например, которые указаны в карточке сделки. Рекомендуем размещать кнопку, по которой открывается окно, в сущности контакта и сделки.
6. Подпишитесь и начните обрабатывать вебхуки по каналам	Как минимум, вам понадобятся `channel.qr_update` и `channel.status_update`. Вебхук `channel.qr_update` нужен, чтобы подключить номерной канал. Например, номер Telegram. Вебхук `channel.status_update`, чтобы узнавать об изменениях статуса канала.
7. Добавьте в сервис возможность подключить канал с помощью iframe или методов по работе с каналами	Чтобы клиент мог подключить каналы к сервису.
8. Настройте синхронизацию контактов вашей CRM и Wazzup	Это нужно, чтобы: показывать диалоги менеджерам, которые указаны ответственными за контакт, пользователь мог быстро попадать на карточку контакта в CRM, можно было инициировать чат из карточки контакта с теми контактами, которых создали в CRM до подключения к Wazzup.
9. Настройте синхронизацию сделок из вашей CRM и Wazzup	Это нужно, чтобы: показывать диалоги менеджерам, которые указаны как ответственные за сделку, менеджер мог видеть список открытых и закрытых сделок у этого контакта, быстро попадать на карточку сделки в CRM.
10. Настройте счетчик неотвеченных	Дает понять, что остались неотвеченные сообщения. Рекомендуем его размещать на кнопке, по которой менеджер переходит в окно со всеми доступными чатами.
11. Научитесь получать и обрабатывать вебхуки о новых сообщениях	Получение новых сообщений → для использования в вашей системе нотификаций.
12. Отладьте работу со списком «Сделки»	1. Проверьте корректность передачи ссылок в `PATCH /v2/contacts` для отображения кнопки-ссылки на страницу контакта в CRM 2. Проверьте корректность передачи ссылок в `PATCH /v2/deals` для отображения ссылок на существующие сделки с данным контактом 3. Научитесь создавать новые сделки при клике пользователем на + в дропдауне «Сделки» по событию. Пока что вебхуки о создании сделки и контакта недоступны.

*Запрещены и признаны экстремистскими на территории РФ