Важные отличия версии v3#

Версия v3 разработана на базе текущей версии GREEN-API. Архитектура и логика взаимодействия с API осталась прежней, однако имеется ряд отличий ввиду особенностей работы мессенджера MAX. Ниже представлены основные отличия версии v3.

Содержание#

• Различия в адресной строке вызова всех методов
• Новый способ авторизации инстанса
• Отправка сообщений
• Идентификатор чата
• Тип мессенджера в вебхуке
• Отказ от использования префиксов @c.us и @g.us
• Неограниченное количество клиентов MAX
• Партнерские методы
• Прочее

Различия в адресной строке вызова всех методов#

В адресную строку вызова всех методов добавлен префикс /v3/

Было:

{{apiUrl}}/waInstance{{idInstance}}/sendMessage/{{apiTokenInstance}}

Стало:

{{apiUrl}}/v3/waInstance{{idInstance}}/sendMessage/{{apiTokenInstance}}

Новый способ авторизации инстанса#

Изменился способ авторизации инстанса. Процесс авторизации стал проще:

• Теперь не требуется наличие физической трубки.
• Также не требуется сканирование QR-кода.
• Требуется только номер телефона и проверочный код из SMS.

Для авторизации инстанса требуется последовательно вызвать два метода. Для начала авторизации вызовите метод StartAuthorization, а после получения кода из SMS отправьте его методом SendAuthorizationCode.

Отправка сообщений#

Для отправки сообщений используется Идентификатор чата. Перед отправкой сообщения требуется вначале получить Идентификатор чата методом CheckAccount, далее выполнить отправку методом SendMessage с использованием chatId.

Для поддержки обратной совместимости с предыдущими версиями интерфейса допускается в методе отправки сообщений SendMessage и др, в качестве идентификатора чата указывать номер телефона клиента в формате phoneNumber@c.us. Допускается использовать только номера телефонов для РФ и РБ с кодами "7" и "375" соответственно.

Идентификатор чата#

Идентификатор чата представлен в строковом типе для обратной совместимости. Однако, рекомендуется выполнять преобразование из строки в число для более компактного хранения в базе данных. Число может быть как положительным - для индивидуальных чатов, так и отрицательным, для групповых чатов. Максимальная длина для групповых чатов составляет 16 символов. Длина идентификатора чата может увеличиться со временем.

Тип мессенджера в вебхуке#

Для определения типа мессенджера, от которого пришел вебхук можно анализировать свойство вебхука instanceData.typeInstance.
Для мессенджера WhatsApp поле будет принимать значение "whatsapp", для мессенджера MAX поле будет принимать значение "v3".
Также можно настроить методом SetSettings получение вебхуков на разные webhookUrl для более надежного определения типа мессенджера и распараллеливания потоков обработки вебхуков от разных мессенджеров.

Отказ от использования префиксов @c.us и @g.us#

Во всех методах отправки сообщений, а также методах работы с журналами и в вебхуках префиксы @c.us и @g.us в Идентификаторе чата больше не используются. Однако, для обратной совместимости допускается указывать префикс @c.us при отправке сообщений по номеру телефона.

Неограниченное количество клиентов MAX#

Мессенджер MAX поддерживает подключение неограниченного количества веб-клиентов и мобильных приложений к одному номеру телефона. Поэтому, можно создать несколько инстансев и подключить несколько клиентов MAX к GREEN-API - по одному к каждому инстансу. Например, один клиент может обслуживать чаты менеджеров, а второй клиент может обслуживать чат-бота на сайте и все с одного номера телефона.

Партнерские методы#

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

Прочее#

Некоторые методы могут возвращать иной набор параметров по сравнению с предыдущей версией, специфичный для мессенджера MAX. Полное описание всех методов и параметров можно найти в Документации API мессенджера MAX