Важные отличия версии 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
Отправка сообщений#
Для отправки сообщений используется Идентификатор чата.
- Если Идентификатор чата известен, то используйте его в методах отправки сообщений SendMessage и др.
- Если Идентификатор чата неизвестен, то сначала используйте метод CheckAccount, получите значение
chatId
, и далее используйтеchatId
в методах отправки сообщений SendMessage и др.
Отправка по номеру телефона
Для поддержки обратной совместимости с предыдущими версиями интерфейса допускается указывать номер телефона клиента в формате phoneNumber@c.us
в качестве идентификатора чата в методе отправки сообщений SendMessage и др.
Допускается использовать только номера телефонов для РФ и РБ с кодами стран 7
и 375
соответственно.
Пример идентификатора чата для РФ: chatId
= 79991234567@c.us
Пример идентификатора чата для РБ: chatId
= 375291234567@c.us
Идентификатор чата#
Идентификатор чата представлен строкой для обратной совместимости. Однако, рекомендуется выполнять преобразование из строки в число для более компактного хранения в базе данных.
Число может быть как положительным (для индивидуальных чатов), так и отрицательным (для групповых чатов).
Максимальная длина значения для групповых чатов составляет 16 символов.
Длина идентификатора чата может увеличиться со временем.
Отказ от использования префиксов @c.us
и @g.us
#
Во всех методах отправки сообщений, а также методах работы с журналами и в вебхуках префиксы @c.us
и @g.us
в Идентификаторе чата больше не используются.
Однако для обратной совместимости допускается указывать префикс @c.us
при отправке сообщений по номеру телефона.
Тип мессенджера в вебхуке#
Для определения типа мессенджера, от которого пришел вебхук, можно анализировать свойство вебхука instanceData.typeInstance
.
- Для мессенджера WhatsApp:
"typeInstance": "whatsapp"
- Для мессенджера MAX:
"typeInstance": "v3"
Также можно настроить методом SetSettings получение вебхуков на разные webhookUrl
для разделения потоков обработки вебхуков от разных мессенджеров.
Неограниченное количество клиентов MAX#
Мессенджер MAX поддерживает подключение неограниченного количества веб-клиентов и мобильных приложений к одному номеру телефона.
Благодаря этому можно создать несколько инстансев и подключить несколько клиентов MAX к GREEN-API - по одному к каждому инстансу.
Например, один клиент может обслуживать чаты менеджеров, а второй клиент может обслуживать чат-бота на сайте и все с одного номера телефона.
Партнерские методы#
Партнерские методы методы не изменились и не требуют доработки.
Полное описание всех партнерских методов можно найти в разделе Партнерские методы.
Прочее#
Некоторые методы могут возвращать набор параметров, специфичный для мессенджера MAX .
Полное описание всех методов и параметров можно найти в Документации API мессенджера MAX