# WhatsApp через Gupshup

!!! Note "N.B."
    Данная функциональность является подключаемой тарифной опцией. Для подключения обратитесь в [техническую поддержку](mailto:support@webim.ru) сервиса.

В версии Webim [10.6](https://webim.ru/webim-10-6/) появилась интеграция с **WhatsApp**[^1] через нового провайдера — [Gupshup](https://www.gupshup.io/). Используя интерфейс сервиса, вы сможете управлять своим бизнес-аккаунтом **WhatsApp** и менять настройки, включая статус активации, имя аккаунта, номер телефона и ключ API.

!!! note "N.B."
    Операторы могут отправлять голосовые сообщения посетителям через интеграцию **WhatsApp (Gupshup)**.  
    Для отображения кнопки записи должны быть одновременно выполнены условия:

      1. разрешено в настройках (аккаунт или отдел);  
      
      1. используется поддерживаемый канал (Gupshup входит в список);  
      
      1. оператор работает в интерфейсе Webim.

Ниже приведена краткая инструкция по подключению официального бизнес-аккаунта **WhatsApp** через **Gupshup**. Интеграция через других провайдеров при этом сохраняется и может настраиваться параллельно с интеграцией через **Gupshup**.

При настройке и эксплуатации интеграции важно, прежде всего, учитывать правила и особенности работы самого **WhatsApp**. Возможность интегрироваться через сторонние API доступна только для официальных бизнес-аккаунтов **WhatsApp** (подробнее [здесь](https://faq.whatsapp.com/ru/general/26000089/?category=5245246)). Также, согласно правилам **WhatsApp**, бесплатны только первые 1000 сервисных сообщений в месяц на номер **WhatsApp**-аккаунта бизнеса: это ответы в течение 24 часов с последнего сообщения посетителя. В лимит также входят [системные сообщения](https://webim.ru/kb/for-admins/system-messages.html) **Webim**, если в настройках канала включены **Системные сообщения**: они уходят как обычные сообщения оператора. Сверх этого лимита такие сообщения **WhatsApp** тарифицирует отдельно. Вне окна обслуживания можно отправлять только шаблоны: в этот лимит они не входят и оплачиваются отдельно.

Также при интеграции с **WhatsApp** через **Gupshup** вам доступна [функциональность рассылок по абонентам WhatsApp](https://webim.ru/kb/for-admins/broadcast.html).

## Шаг 1. Создание аккаунта Gupshup и настройка API

  1. [Зарегистрируйтесь](https://api.gupshup.io/sm/api/user/authorize?prompt=login&lang=en) на платформе **Gupshup**.

  1. После регистрации и активации аккаунта перейдите на вкладку [**WhatsApp**](https://www.gupshup.io/whatsapp/dashboard).

    ![Вкладка WhatsApp в личном кабинете Gupshup](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/gupshup-dashboard.webp)

  1. Нажмите на кнопку **Create your first app**.

    ![Кнопка «Create your first app» в Gupshup](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/create-first-app.webp)

  1. На открывшейся странице нажмите на кнопку **Access API**.

  1. Введите имя приложения. Оно должно быть уникальным и не совпадать с именами прочих приложений.

    ![Ввод имени приложения в Gupshup](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/enter-app-name.webp)

  1. Если имя аккаунта соответствует требованиям **Gupshup** Вы увидите сообщение *Created successfully*. Нажмите на кнопку **Go to Dashboard** или перейдите в раздел **Dashboard** самостоятельно.

    ![Сообщение об успешном создании приложения в Gupshup](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/app-succesful-create.webp)

  1. В дашборде **Gupshup** будут отображаться все созданные Вами приложения. Нажмите на имя созданного вами на предыдущих шагах приложения. Вы перейдёте в его настройки. Оставьте эту вкладку в браузере открытой, данные из настроек приложения будут необходимы для создания канала общения в **Webim**.

## Шаг 2. Создание канала общения в Webim

!!! Warning "Внимание!"
    В зависимости от типа используемого приложения **Gupshup** меняется поведение канала общения. В случае, если Вы используете приложение "в песочнице" (не рекомендуется), Вы получите лишь частичную функциональность - в частности, будут недоступны рассылки. Для создания полноценного канала общения используйте live-версию приложения **Gupshup**! Подробную инструкцию по переводу приложения в live-режим Вы можете найти в [официальной документации](https://support.gupshup.io/hc/en-us/articles/360012075939-What-is-required-to-Go-Live-with-my-app-)

  1. Перейдите в раздел **Настройки** -> **Каналы общения**.

  1. Найдите в списке доступных каналов общения канал **WhatsApp Gupshup**.

  1. Нажмите на кнопку **Добавить**.

  1. В открывшемся окне заполните поле **Название канала**. Название канала не является названием приложения **Gupshup**, а также будет отображаться в интерфейсе оператора.

    ![Создание канала WhatsApp Gupshup в Webim](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/channel-create.webp)

  1. Нажмите на кнопку **Сохранить**.

  1. Созданный канал появится в списке каналов общения. На данный момент канал создан, но не настроен. Для продолжения работы с каналом нажмите на пиктограмму карандаша.

    ![Новый канал WhatsApp Gupshup в списке каналов общения](https://webim.ru/kb/img/channels/social-network-messengers/whatsapp/whatsapp-gupshup/channel-in-list.webp)

  1. В открывшемся окне заполните следующие поля в соответствии с их значениями в дашборде **Gupshup**:

    * **Номер телефона**:

      * Для тестового канала: скопируйте значение из конфигурации приложения **Gupshup**. Его можно найти в разделе **Sandbox** под именем **Sender number**.

      * Для live-канала: введите номер телефона, привязанный к приложению **Gupshup**.

    * **Название приложения**: название Вашего приложения на платформе **Gupshup**.

    * **Идентификатор приложения**: скопируйте значение из конфигурации приложения **Gupshup**. Его можно найти в разделе **Settings** под именем **App ID**.

    * **API ключ**: скопируйте значение из конфигурации приложения **Gupshup**. Его можно получить, нажав на свою аватару в правом верхнем углу, а затем на пиктограмму копирования во всплывающем меню.

  1. При необходимости настройте оставшиеся опции:

    * Чекбокс **Системные сообщения**: отправлять или нет [системные сообщения](https://webim.ru/kb/for-admins/system-messages.html) в чат с посетителем.

    * Выпадающий список **Выбор отдела**: выберите, нужен ли выбор отдела в канале общения.

      * Если выбор отдела обязателен, в выпадающем списке **Доступные для выбора отделы** выберите отделы, которые сможет выбрать посетитель.

      * Если выбор отдела не нужен, в выпадающем списке **Обращение для отдела** выберите отдел, в который будет направлено обращение.

  1. Нажмите на кнопку **Сохранить**.

Результатом этого шага станет готовый к использованию канал общения.

## Отправка файлов (вложения) в WhatsApp

Интеграция поддерживает два способа отправки вложений:

  1. По ссылке. В сообщении передается URL на файл из хранилища Webim.

  1. Через media_id. Файл предварительно загружается на сторону WhatsApp-провайдера, а клиенту отправляется `media_id`.

Переключение способов задается параметром account config `use_whatsapp_media_id`.

  * Если `use_whatsapp_media_id = false` (по умолчанию), вложения отправляются по ссылке.

  * Если при отправке по ссылке у получателей вложения не доходят/не отображаются, включите `use_whatsapp_media_id = true`, чтобы отправлять через media_id.

Как изменить параметр: см. [Редактор настроек аккаунта](https://webim.ru/kb/for-admins/service-pages/account-config-editor.html).  
Описание параметров сервера: см. [Параметры настроек сервера](https://webim.ru/kb/devops/server-account-config-parameters.html).

## Рассылки

В рассылках **WhatsApp** через **GupShup** поддерживаются:

  * Шаблоны с кнопками.

  * Шаблоны с медиа (изображение, документ, аудио, видео).

Параметры указываются только для [тела](https://webim.ru/kb/dev/api/realtime-2.0.html#_5) запроса.

Более подробно о том, как работают рассылки, описано в [этой](https://webim.ru/kb/for-admins/broadcast.html#whatsapp-broadcast) статье.

[^1]: WhatsApp принадлежит корпорации Meta, деятельность которой признана экстремистской и запрещена в РФ.

---

Источник: https://webim.ru/kb/channels/social-network-messengers/whatsapp/whatsapp-gupshup.html