Настроить интеграцию с WhatsApp

Продукты
Все продукты

WhatsApp является одним из продуктов компании Facebook, поэтому для настройки интеграции с этим мессенджером вам необходимы:

  • Учетная запись в Facebook Business Manager. Если вы еще не зарегистрированы, воспользуйтесь инструкцией Facebook (на английском).
  • Интеграция с партнерской платформой Facebook, которая предоставляет доступ к WhatsApp Business API. На данный момент такой платформой является Twilio.

Для ознакомления с возможностями интеграции с WhatsApp вы можете зарегистрировать тестовую учетную запись с ограниченным доступом к функциональности. Чтобы воспользоваться всеми преимуществами интеграции с WhatsApp, необходимо пройти верификацию ваших учетных записей. Это поможет обезопасить ваши данные и ваших клиентов. В общем случае настройка интеграции с WhatsApp состоит из следующих шагов:

  1. Настроить в Twilio тестовую учетную запись для ознакомления (опционально). Подробнее >>>
  2. Настроить в Twilio учетную запись для бизнеса. Подробнее >>>
  3. Настроить в Creatio канал чатов WhatsApp. Подробнее >>>

Для канала WhatsApp действуют следующие ограничения на пересылку файлов:

  • Изображения форматов *.jpg, *.jpeg, *.png.
  • Аудиофайлы форматов *.mp3, *.ogg, *.amr.
  • Документы формата *.pdf.
  • Видео формата *.mp4.
  • Максимальный размер файла — 16 Mб.

Подробнее о допустимых форматах файлов читайте в документации Twilio.

На заметку. Список стран, с поставщиками телекоммуникационных услуг которых работает Twilio, ограничен. Ознакомьтесь с их перечнем. (Кроме перечисленных, у Twilio нет ограничений для номеров США). Если Ваш номер не попадает в список допустимых, ознакомьтесь с инструкцией Twilio.

Шаг 1. Настроить тестовую учетную запись (опционально) 

Настройка тестовой учетной записи в Twilio не требует верификации и подключения платных услуг платформы. Она позволяет протестировать возможности интеграции Creatio с WhatsApp, обмена сообщениями и файлами в чате. Настройка тестовой интеграции состоит из следующих шагов:

  1. Настроить в Twilio тестовую учетную запись. Подробнее >>>
  2. Настроить в Creatio канал чатов WhatsApp. Подробнее >>>

Настроить тестовую учетную запись в Twilio 

  1. Зарегистрируйтесь на https://www.twilio.com/try-twilio. После завершения регистрации вы сможете настроить тестовую интеграцию. Также вам будет предоставлен лимит средств для проверки функциональности.

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

  2. Укажите endpoint URL для передачи чатов в Creatio. Для этого перейдите в настройки “песочницы” (“sandbox”) в Twilio:

    Twilio Console — > Programmable Messaging — > Settings — > WhatsApp Sandbox Settings — > Sandbox Configuration и в поле WHEN A MESSAGE COMES IN введите значение “https://sm-receiver.creatio.com/api/webhook/LeadGen/whatsapp”.

  3. Настройте “песочницу” (“sandbox”) в Twilio:

    Twilio Console — > Programmable Messaging —> Try it out —> Send a WhatsApp message.

  4. Отправьте код, сформированный Twilio, через WhatsApp с вашего номера на номер вашей тестовой учетной записи. Если сообщение будет доставлено успешно, вы получите уведомление в Twilio. В результате ваш номер будет добавлен в Sandbox Participants.
  5. Если вы хотите использовать для тестирования несколько номеров, повторите шаг 3 для каждого из них. Просмотреть список номеров, которые вы используете для тестовых целей можно в списке Sandbox Participants:

    Twilio Console — > Programmable Messaging — > Settings — > WhatsApp Sandbox Settings — > Sandbox Participants.

    После этого вы сможете получать на номер вашей тестовой записи сообщения от номеров, добавленных в Sandbox Participants.

Настроить тестовый канал WhatsApp в Creatio 

Перед настройкой канала убедитесь, что в вашем приложении заполнены системные настройки “Адрес Identity сервера” (код “IdentityServerUrl”), “Идентификатор приложения для Identity сервера” (код “IdentityServerClientId”) и “Секретный ключ для Identity сервера” (код “IdentityServerClientSecret”). Если данные системные настройки не заполнены, обратитесь в службу поддержки Creatio.

  1. Перейдите в дизайнер системы по кнопке btn_system_designer .
  2. Откройте раздел Настройка чатов.
  3. В области Каналы нажмите кнопку "" . В появившемся меню выберите “WhatsApp”.
  4. В открывшейся мини-карточке заполните параметры канала:
    1. Номер телефона — номер вашей тестовой учетной записи в Twilio.
    2. Номер телефона для подтверждения — номер телефона, который входит в Sandbox Participants в Twilio.
    3. Id приложения — SID тестовой учетной записи Twilio, который указан в поле ACCOUNT SID Twilio Console.
    4. Токен — токен, сгенерированный Twilio для тестовой учетной записи. Указан в поле AUTH TOKEN Twilio Console.
  5. Нажмите Подключить.
  6. Активируйте канал чата. Для этого в открывшейся мини-карточке:
    1. Установите индикатор в положение Активен.
    2. Выберите очередь чата, в которой будут обрабатываться сообщения, полученные по данному каналу.
    3. Нажмите Применить.

В результате в Creatio будет подключен тестовый канал WhatsApp, вы сможете проверить возможности получения и обработки сообщений и файлов.

Шаг 2. Настроить учетную запись для бизнеса 

Чтобы воспользоваться всеми возможностями, которые предоставляет Twilio для бизнеса, вам необходимо зарегистрироваться на платформе и пройти верификацию. Подробнее читайте в документации Twilio (на английском).

В общем случае порядок настройки выглядит следующим образом:

  1. Зарегистрируйтесь в Facebook Business Manager.
    1. Если у вашей компании уже зарегистрирована учетная запись, то перейдите к шагу 2.
    2. Если учетной записи еще нет, то следуйте инструкциям в документации Facebook.
  2. Зарегистрируйтесь в Twilio.
  3. Укажите endpoint URL для передачи чатов в Creatio. Для этого перейдите в настройки “песочницы” (“sandbox”) в Twilio:

    Twilio Console — > Programmable Messaging — > Settings — > WhatsApp Sandbox Settings — > Sandbox Configuration и в поле WHEN A MESSAGE COMES IN введите значение “https://sm-receiver.creatio.com/api/webhook/LeadGen/whatsapp”.

  4. Пройдите верификацию WhatsApp.
    1. Отправьте в WhatsApp запрос на активацию вашего номера Twilio. В поле Are you working with an ISV, SI, or third party укажите ”No” (Нет). После отправки запроса вы должны получить на указанный при заполнении формы email-адрес письмо с предварительным подтверждением и описанием дальнейших шагов.
    2. Добавьте номер телефона:

      Twilio Console —> Programmable Messaging —> Senders —> WhatsApp Senders и нажмите кнопку New WhatsApp Sender.

      Вы можете использовать свой номер телефона или приобрести номер Twilio.

      На заметку. При заполнении профиля придерживайтесь правил для отображаемых имен WhatsApp.

    3. Разрешите Twilio отправлять сообщения от вашего имени. Для этого перейдите в Facebook Business Manager и подтвердите запрос Twilio на отправку сообщений от имени вашей компании. Вы можете найти данный запрос:
      • На business.facebook.com —> Настройки —> Настройки компании —> Запросы.
      • Перейти по ссылке из электронного письма с предварительным подтверждением вашего номера телефона
    4. Пройдите проверку компании в Facebook Business Manager. Если ваша компания была подтверждена ранее, то переходите на следующий шаг. Для выполнения проверки перейдите:

      Facebook Business Manager —> Настройки —> Настройки компании —> Центр безопасности и нажмите кнопку Начать подтверждение или Продолжить в разделе Подтверждение компании.

      Подробно процесс подтверждения бизнеса описан в документации Facebook.

    5. Подтвердите завершение регистрации, перейдя по ссылке из электронного письма от Twilio.

В результате в течение 24 часов после завершения верификации вам будет подключена возможность общаться с клиентами по WhatsApp с зарегистрированного номера.

Шаг 3. Добавить канал WhatsApp в Creatio 

Перед настройкой канала убедитесь, что в вашем приложении заполнены системные настройки “Адрес Identity сервера” (код “IdentityServerUrl”), “Идентификатор приложения для Identity сервера” (код “IdentityServerClientId”) и “Секретный ключ для Identity сервера” (код “IdentityServerClientSecret”). Если данные системные настройки не заполнены, обратитесь в службу поддержки Creatio.

  1. Перейдите в дизайнер системы по кнопке btn_system_designer .
  2. Откройте раздел Настройка чатов.
  3. В области Каналы нажмите кнопку "" . В появившемся меню выберите “WhatsApp”.
  4. В открывшейся мини-карточке заполните параметры канала:
    1. Номер телефона — номер телефона, подключенный и верифицированный в Twilio.
    2. Номер телефона для подтверждения — номер телефона, на который придет сообщение для подтверждения канала.
    3. Id приложения — SID учетной записи Twilio, который указан в поле ACCOUNT SID Twilio Console.
    4. Токен — токен, сгенерированный Twilio для вашей учетной записи. Указан в поле AUTH TOKEN Twilio Console.
  5. Нажмите Подключить.
    Рис. 1 — Пример настройки канала WhatsApp
    scr_setup_chat_channel_whatsapp.png
  6. Если верификация канала прошла успешно, то откроется мини-карточка редактирования канала. Чтобы сообщения из созданного канала были доступны для обработки в коммуникационной панели, активируйте канал и привяжите его к очереди. Для этого:

    1. Установите индикатор в положение Активен.
    2. Выберите очередь чата, в которой будут обрабатываться сообщения, полученные по данному каналу.
    3. Укажите язык, на котором предполагаете получать сообщения по данному каналу. Это необходимо, чтобы операторы могли использовать шаблоны быстрых ответов на языке клиентов.
    4. Нажмите Применить.

В результате в Creatio будет подключен канал WhatsApp, операторы контакт-центра смогут обрабатывать сообщения данного канала на коммуникационной панели Creatio. Вся история переписки будет сохранена в разделе Чаты.

На заметку. Обратите внимание, что один номер WhatsApp может быть связан только с одним приложением Creatio. Если вы добавите один номер на несколько приложений, например, среду разработки, тестовый и продуктовый сайты, то сообщения будут приходить только на тот сайт, интеграция с которым была настроена последней.