Перед началом работы#

Перед началом работы с Green API требуется выполнить следующие шаги:

1. Установить мобильное приложение WhatsApp
2. Регистрация в Личном кабинете
3. Создание и авторизация инстанса
4. Получить параметры доступа к инстансу
5. Настроить получение входящих данных

Видеоинструкция#

1. Установить мобильное приложение WhatsApp#

Отправка и получение сообщений WhatsApp выполняется с вашего мобильного телефона. На телефоне должно быть установлено официальное мобильное приложение WhatsApp или WhatsApp Business.

Рекомендуется заказать услугу Хостинг трубки. В этом случае наличие личного мобильного телефона не требуется. Отправка и получение сообщений WhatsApp будет выполняться с мобильного телефона, расположенного в дата-центре Green API.

2. Регистрация в Личном кабинете#

Для использования нашего сервиса перейдите в Личный кабинет и зарегистрируйтесь. Порядок регистрации:

1. Введите электронную почту.

   Рекомендуем использовать корпоративную почту, для предотвращения потери доступа к учетной записи, при увольнении сотрудника.

2. Введите пароль и подтвердите его. Длина пароля должна быть не менее 6 символов.

3. Выберите страну.
4. Приняв пользовательское соглашение, нажмите на кнопку Зарегистрироваться.
5. На Ваш адрес электронной почты будет направлено письмо. Введите код, указанный в письме, для подтверждения вашей учетной записи.

3. Создание и авторизация инстанса#

Создание инстанса#

Инстанс - это уникальный номер шлюза для отправки и получения сообщении через WhatsApp.

Инстанс создается в личном кабинете и используется для организации HTTP API WhatsApp.

Один инстанс может одновременно обслуживать только один номер телефона (один аккаунт WhatsApp). В одной учетной записи можно создать несколько инстансев.

Порядок создания инстанса:

1. В личном кабинете нажмите на кнопку Создать инстанс.
2. Выберите тарифный план
3. Если требуется, выберите способ оплаты и проведите оплату.
4. Перейдите в список инстансев, нажав на кнопку Инстансы в боковом меню. В списке можете увидеть созданный вами инстанс.

Переход инстанса в рабочее состояние после создания может занимать до 2-х минут. Формирование QR кода возможно через 2 минуты после создания инстанса.

Авторизация инстанса#

Для работы с Green API требуется авторизовать инстанс. Авторизация инстанса выполняется в Личном кабинете путем считывания QR-кода из мобильного приложения WhatsApp Business или WhatsApp.

Порядок авторизации инстанса:

1. Откройте на своем мобильном телефоне приложение WhatsApp Business или WhatsApp. На устройстве перейдите в раздел Привязка устройства, для этого:

   • На Android нажмите на 3 точки -> Связанные устройства -> Привязка устройства
   • На iPhone перейдите в Настройки -> Связанные устройства -> Привязка устройства

2. Перейдите в личный кабинет. Выберите нужный вам инстанс.

3. Нажмите на кнопку Получить QR. Отсканируйте QR код.

   

Подробнее читайте в нашей статье "Как выполнить привязку устройства?".
Также рекомендуем ознакомится со статьей "Почему не получается связать устройство с API?".

Отправка и получение сообщений выполняется с вашего мобильного телефона. Поэтому телефон должен быть всегда заряжен и подключен к сети Интернет.

4. Получить параметры доступа к инстансу#

Для выполнения запросов HTTP API WhatsApp требуется использовать параметры доступа к инстансу. Параметры доступа публикуются в личном кабинете:

• apiUrl - ссылка на хост API
• mediaUrl - ссылка на хост API для отправки файлов
• idInstance - уникальный номер инстанса
• apiTokenInstance - ключ доступа инстанса

Ключ доступа инстанса можно сменить при необходимости, например, в случае его компрометации. Сменить токен можно в личном кабинете самостоятельно или обратившись в техподдержку.

5. Настроить получение входящих данных#

Если требуется получать входящие данные (входящие сообщения, статусы ранее отправленных сообщений и др.), то предварительно необходимо выполнить настройку инстанса. Получать входящие уведомления можно через HTTP API или через Webhook Endpoint.

Готово!#

Всё готово для начала отправки и получения сообщений WhatsApp!

Для отладки запросов к Green API рекомендуется использовать раздел API в личном кабинете или Коллекцию Postman. Для упрощения написания интеграции Вы можете воспользоваться готовыми библиотеками в разделе SDK.