Создание и настройка инстанса#

Настройки инстанса#

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

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

Можно использовать рекомендуемые параметры или расставить их в зависимости от ваших потребностей.

Сценарий создания и настройки инстанса#

1. После создания инстанса через личный кабинет или используя метод партнера createInstance, требуется дождаться завершения создания инстанса (создание и инициализация инстанса занимает до 5 минут).

   Используя метод getStateInstance, можно проверять состояние инстанса.
   Тело ответа null при запросе метода getStateInstance, обозначает что инстанс все еще создается. Вы можете использовать данный маркер до момента получения статуса готовности инстанса к работе notAuthorized.

2. После получения статуса notAuthorized требуется произвести установку настроек методом SetSettings или через личный кабинет

3. Установка настроек занимает до 5 минут. В это время можно запросить QR-код для связывания с устройством. Запрос кода рекомендуется делать с использованием технологии вебсокет, так можно гарантировать получение актуального кода на протяжении всего процесса связывания с устройством.

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

4. После успешного связывания с устройством, запросы на получения QR-кода требуется прекратить. Настройки инстанса не меняются со временем, повторно устанавливать настройки инстанса не требуется.
   Проверить установку настроек можно, с помощью метода GetSettings.

   При создании инстанса методом партнера createInstance, можно указать значения настроек на инстансе.

Рекомендуемые параметры#

Рекомендуемые параметры запроса:

{
    "webhookUrl": "https://mysite.com/webhook/green-api/", // URL для получения входящих уведомлений
    "webhookUrlToken": "",                      // токен для доступа к вашему серверу уведомлений
    "delaySendMessagesMilliseconds": 3000,      // время отправки сообщений из очереди
    "markIncomingMessagesReaded": "no",         // отмечать входящие сообщения прочитанными    
    "markIncomingMessagesReadedOnReply": "yes", // отмечать входящие сообщения прочитанными при ответе собеседнику
    "outgoingWebhook": "yes",                   // получать уведомления о статусах отправленных сообщений
    "outgoingMessageWebhook": "yes",            // получать уведомления при отправке с устройства
    "outgoingAPIMessageWebhook": "no",          // получать уведомления при отправке с API
    "incomingWebhook": "yes",                   // получать уведомления о входящих сообщениях
    "deviceWebhook": "no",                      // получать уведомления об устройстве
    "stateWebhook": "yes",                      // получать уведомления об изменении состояния авторизации аккаунта
    "keepOnlineStatus": "yes",                  // выставляет статус 'В сети' для вашего аккаунта
    "pollMessageWebhook": "yes",                // получать уведомления о создании опроса и голосовании в опросе
    "incomingBlockWebhook": "yes"               // получать уведомления о добавлении чата в список заблокированных контактов
}

Получение информации об аккаунте#

Для получения информации о аккаунте реализованы методы:

1. GetSettings - предназначен для получения текущих настроек аккаунта.
2. GetStateInstance - предназначен для получения состояния аккаунта, таких как notAuthorized, authorized и т.д.
3. GetWaSettings - предназначен для получения информации о аккаунте WhatsApp. Возвращает аватар, номер телефона аккаунта WhatsApp и состояние инстанса.