Перейти к содержанию

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

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

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

Регистрация нового номера в MAX

Если Вы подключаете новый номер, на котором ранее не использовался MAX, то рекомендуем ознакомиться со статьей Как снизить риск блокировки MAX

1. Установка мобильного приложения MAX#

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

  1. Установите официальное мобильное приложение:

  2. Откройте приложение и нажмите Войти

  3. Введите свой номер телефона и подтвердите его с помощью кода из SMS

    Перечень поддерживаемых стран, особенности регистрации и оправкии сообщений.

    Регистрация в данный момент возможна на мобильные номера Российской Федерации, Азербайджана, Армении, Афганистана, Беларуси, Боливии, Венесуэлы, Вьетнама, Гамбии, Гренады, Грузии, ДР Конго, Индии, Индонезии, Ирака, Казахстана, Камбоджи, Катара, Колумбии, Кубы, Кувейта, Кыргызстана, Лаоса, Ливана, Малайзии, Молдовы, Мьянмы, Никарагуа, ОАЭ, Пакистана, Палау, Республики Конго, Саудовской Аравии, Сент-Китса и Невиса, Таджикистана, Таиланда, Танзании, Туркменистана, Турции, Узбекистана.

    Подробнее о регистрации и отправке сообщений между регионами читайте в нашей статье Регистрация в MAX, если номер не из РФ или РБ.

    Регистрация возможна на мобильном или десктопном приложении. Веб версия MAX не подходит для регистрации аккаунта.

  4. Выберите настройки доступа к контактам и укажите данные профиля (имя, аватар и др.)

После регистрации в мобильном приложении мессенджера MAX вы сможете использовать все функции приложения - отправлять и получать сообщения, совершать звонки и пр.

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

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

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

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

  2. Выберите страну

  3. Примите пользовательское соглашение и нажмите на кнопку Зарегистрироваться

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

    Рекомендуем проверять помимо общих входящих сообщений папку Спам, так как письмо может оказаться там

register
code

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

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

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

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

Один инстанс может одновременно обслуживать только один номер телефона (один аккаунт мессенджера MAX).
В одной учетной записи личного кабинета GREEN-API можно создать неограниченное количество инстансов (каждый инстанс тарифицируется отдельно)

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

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

  4. Перейдите в список инстансев, нажав на кнопку Инстансы в боковом меню. В списке можете увидеть созданный вами инстанс

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

create

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

Для работы с GREEN-API требуется авторизовать инстанс.

Внимание!

В настоящее время для авторизации по QR-коду необходимо отключить пароль для входа в мессенджере MAX.

Авторизация выполняется в Личном кабинете путем получения QR-кода мессенджера MAX или методом QR.

  1. Откройте на своем мобильном телефоне приложение MAX. На устройстве перейдите в раздел устройства, для этого:
    • Нажмите на Профиль -> Устройства -> Войти по QR-коду
  2. Перейдите в личный кабинет. Выберите нужный вам инстанс.
  3. Нажмите на кнопку Получить QR-код для авторизации. Отсканируйте QR код.

get-gr-button

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

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

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

parameters

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

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

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

Получение входящих уведомлений реализуется одной из следующих технологий:

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

Версия v3 разработана на базе текущей версии GREEN-API.

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

Готово!#

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