Документация MAX API

Прием и отправка сообщений через HTTP-запросы для работы с MAX - работа с чатами, контактами, группами.

Попробовать бесплатно

5 дней пробный период

MAX API

Описание MAX API для сервиса Wappi

Методы отправки сообщений

Сообщение в MAX можно отправить синхронно или асинхронно: асинхронный метод ставит задачу в очередь и возвращает ID, а синхронный сразу отправляет и отдает результат.

Особенности API

Это так называемый пользовательский MAX API, в котором можно авторизовать личный аккаунт в мессенджере Max по номеру телефона.

Токен авторизации передается в заголовке Authorization HTTP запроса. Profile_id передается query параметром в каждом запросе.

Безопасность

Этот API не предназначен для флуда, спама, накруток - мессенджер MAX может вас забанить. Рекомендуем использовать свои собственные http прокси для подключения.

MAX MCP сервер

Подключайте MAX API к Claude, ChatGPT и Cursor через MCP сервер Wappi. Ассистент поможет быстрее находить методы, собирать запросы и включать MAX в общую логику CRM или сервиса.

Коллекция Postman

Для удобства тестирования нашего API можете воспользоваться коллекцией Postman. Там же можно найти примеры реализованных методов на разных языках программирования.

Методы API

Все методы MAX APIПолный справочник - 71 методСвернутьРазвернуть
Работа с профилем12 методов
POSTСоздать профиль/maxapi/profile/add

URL: https://wappi.pro/maxapi/profile/add?name=новый3&webhook_url=https://wappi.pro

Описание метода

Метод предназначен для создания нового профиля.

Вы передаете имя нового профиля, а его profile_id автоматически генерируется системой и возвращается в ответе.

Query Params
ПараметрЗначениеОписание
nameновый3Обязательный параметр. Имя нового профиля.
webhook_urlhttps://wappi.proНеобязательный параметр. Установка URL ссылки на вебхук.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Создать профиль200
{
  "profile_id": "21f018f2-647a",
  "status": "done",
  "time": "2026-03-06T13:03:50+03:00",
  "timestamp": 1772791430
}
POSTУдалить профиль/maxapi/profile/delete

URL: https://wappi.pro/maxapi/profile/delete?profile_id={{profile_id}}

Описание метода

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

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Удалить профиль200
{
  "detail": "Profile cea791a3-8a21 deleted",
  "status": "done",
  "time": "2025-08-06T12:09:10+03:00",
  "timestamp": 1754471350
}
GETПолучить статус и настройки профиля/maxapi/sync/get/status

URL: https://wappi.pro/maxapi/sync/get/status?profile_id={{profile_id}}

Описание метода

Получение статуса и настроек профиля.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить статус и настройки профиля200
{
  "app_status": "close",
  "authorized": false,
  "authorized_at": null,
  "checked_at": "2025-08-06T12:08:15.617842+03:00",
  "last_activity": 0,
  "logouted_at": null,
  "message_count": 0,
  "name": "новый3",
  "payment_expired_at": "2025-08-07T00:00:00Z",
  "payment_notification": true,
  "phone": "",
  "platform": "max",
  "profile_id": "d6f3286b-e584",
  "proxy": "",
  "uuid": "d6f3286b-e584",
  "webhook_types": [
    "incoming_message",
    "delivery_status",
    "authorization_status"
  ],
  "webhook_url": "",
  "worked_days": 0
}
GETПолучить все профили/maxapi/profile/all/get

URL: https://wappi.pro/maxapi/profile/all/get

Описание метода

Получение сведений о всех профилях MAX в аккаунте.

Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить все профили200
{
  "profiles": [
    {
      "app_status": "",
      "proxy": "",
      "profile_id": "5dbf254b-8290",
      "name": "max2",
      "webhook_url": "",
      "authorized": true,
      "uuid": "5dbf254b-8290",
      "is_subscribe": false,
      "checked_at": "2025-07-28T21:44:52.159424+03:00",
      "authorized_at": "2025-08-04T19:29:15.65488+03:00",
      "logouted_at": null,
      "phone": "79111104491",
      "worked_days": 0,
      "webhook_types": [
        "incoming_message",
        "delivery_status",
        "authorization_status"
      ],
      "wh_types": null,
      "last_activity": 0,
      "message_count": 1,
      "payment_notification": true,
      "deleted_at": null,
      "platform": "max"
    },
    {
      "app_status": "",
      "proxy": "",
      "profile_id": "7ef2017c-2f43",
      "name": "новый2",
      "webhook_url": "",
      "authorized": false,
      "uuid": "7ef2017c-2f43",
      "is_subscribe": false,
      "checked_at": "2025-08-04T19:22:49.679688+03:00",
      "authorized_at": null,
      "logouted_at": null,
      "phone": "",
      "worked_days": 0,
      "webhook_types": [
        "incoming_message",
        "delivery_status",
        "authorization_status"
      ],
      "wh_types": null,
      "last_activity": 0,
      "message_count": 0,
      "payment_notification": true,
      "deleted_at": null,
      "platform": "max"
    },
    {
      "app_status": "",
      "proxy": "",
      "profile_id": "3a91f18a-1be9",
      "name": "Профиль",
      "webhook_url": "https://webhook.site/6b374985-cdcc-450c-905e-0b3124dd5268",
      "authorized": true,
      "uuid": "3a91f18a-1be9",
      "is_subscribe": false,
      "checked_at": "2025-08-04T19:21:17.272388+03:00",
      "authorized_at": "2025-08-04T19:45:15.086389+03:00",
      "logouted_at": "2025-08-04T19:38:17.382368+03:00",
      "phone": "79815435353",
      "worked_days": 0,
      "webhook_types": [
        "incoming_message",
        "delivery_status",
        "authorization_status"
      ],
      "wh_types": null,
      "last_activity": 0,
      "message_count": 0,
      "payment_notification": true,
      "deleted_at": null,
      "platform": "max"
    },
    {
      "app_status": "",
      "proxy": "",
      "profile_id": "d6f3286b-e584",
      "name": "новый3",
      "webhook_url": "https://webhook.site/944561a8-0a8f-4598-ae01-bd485d09cfd3",
      "authorized": true,
      "uuid": "d6f3286b-e584",
      "is_subscribe": false,
      "checked_at": "2025-08-06T12:08:15.617842+03:00",
      "authorized_at": "2025-08-07T02:26:44.823245+03:00",
      "logouted_at": null,
      "phone": "79815345353",
      "worked_days": 0,
      "webhook_types": [
        "authorization_status",
        "incoming_message",
        "delivery_status",
        "outgoing_message_phone",
        "outgoing_message_api",
        "application_status"
      ],
      "wh_types": null,
      "last_activity": 0,
      "message_count": 15,
      "payment_notification": true,
      "deleted_at": null,
      "platform": "max"
    },
    {
      "app_status": "",
      "proxy": "",
      "profile_id": "bf005295-6f91",
      "name": "MAXTEST",
      "webhook_url": "https://webhook.site/6b374985-cdcc-450c-905e-0b3124dd5268",
      "authorized": true,
      "uuid": "bf005295-6f91",
      "is_subscribe": false,
      "checked_at": "2025-07-24T17:46:40.336174+03:00",
      "authorized_at": "2025-08-07T02:23:12.396377+03:00",
      "logouted_at": "2025-08-03T17:05:20.749941+03:00",
      "phone": "79115576361",
      "worked_days": 0,
      "webhook_types": [
        "authorization_status",
        "incoming_message",
        "delivery_status",
        "outgoing_message_phone",
        "outgoing_message_api",
        "application_status"
      ],
      "wh_types": null,
      "last_activity": 0,
      "message_count": 140,
      "payment_notification": true,
      "deleted_at": null,
      "platform": "max"
    }
  ],
  "status": "done"
}
GETПерезагрузить профиль/maxapi/profile/restart

URL: https://wappi.pro/maxapi/profile/restart?profile_id={{profile_id}}

Описание метода

Перезагрузка приложения (профиля).

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Перезагрузить профиль200
{
  "detail": "Your profile has been restarted",
  "status": "done"
}
GETАвторизовать по QR/maxapi/sync/auth/qr

URL: https://wappi.pro/maxapi/sync/auth/qr?profile_id={{profile_id}}

Описание метода

Метод для авторизации в MAX по QR коду. Запрос позволяет получить QR код с неавторизованного профиля.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw

Тело запроса не передается.

Responses
Авторизовать по QR200
{
  "status": "done",
  "timestamp": 0,
  "time": "2026-02-20T16:44:19+03:00",
  "detail": "",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-20T16:44:19.906753354+03:00",
  "uuid": "15396b7f-9383"
}
POSTВвести облачный пароль 2fa/maxapi/sync/auth/2fa

URL: https://wappi.pro/maxapi/sync/auth/2fa?profile_id={{profile_id}}

Описание метода

Метод позволяет ввести облачный пароль двухфакторной авторизации, чтобы авторизоваться в MAX

Request Body

ПараметрТип данныхОбяз.Описание
pwd_codestringДаПароль двухфакторной авторизации (2FA), установленный в аккаунте MAX.
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "pwd_code": "string"
}
Responses
Ввести облачный пароль 2fa200
{
  "status": "done",
  "detail": "auth_success",
  "uuid": "fae370e3-0a5е"
}
GETВыйти из max/maxapi/profile/logout

URL: https://wappi.pro/maxapi/profile/logout?profile_id={{profile_id}}

Описание метода

Разавторизация в MAX.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Выйти из max200
{
  "status": "done",
  "timestamp": 1754569518,
  "time": "2025-08-07T15:25:18+03:00",
  "detail": "logout success",
  "task_id": "0b64c11c-6f51-4ed3-939b-e94c965d1477",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2025-08-07T15:25:18.772003061+03:00",
  "uuid": "d6f3286b-e584"
}
POSTОплатить профиль с баланса/payments/balance/add_days

URL: https://wappi.pro/payments/balance/add_days

Описание метода

Метод позволяет оплатить один или несколько профилей за счёт средств на балансе Wappi с применением выбранного тарифа.

Request Body

ПараметрТип данныхОбяз.Описание
profile_uuidstringДаID профиля, для которого выполняется оплата Можно получить в личном кабинете на странице конкретного профиля.
tariff_idintegerДаID выбранного тарифа
Доступные тарифы:
1 - Базовый 1 месяц;
2 - Базовый 3 месяца;
3 - Базовый 6 месяцев;
4 - Базовый 12 месяцев;
5001 - Полный 1 месяц;
5002 - Полный 3 месяца;
5003 - Полный 6 месяцев;
5004 - Полный 12 месяцев.
profile_idsarray of stringНетМассив ID дополнительных профилей для оплаты
Если указаны, оплата применяется ко всем профилям из profile_uuid и profile_ids.
codestringНетПромо-код на скидку
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "profile_uuid": "uuid",
  "tariff_id": 1,
  "profile_ids": [
    "uuid",
    "uuid2"
  ],
  "code": "promo_code"
}
Responses
Оплатить профиль с баланса200
/dashboard/15396b7f-4263
GETПолучить историю авторизаций профиля/panel/profile/auth/history

URL: https://wappi.pro/panel/profile/auth/history?profile_id={{profile_id}}

Описание метода

Получение истории авторизаций в профиле.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить историю авторизаций профиля200
{
  "auth_history": [
    {
      "type": "login",
      "phone": "79765656542",
      "created_at": "2026-02-19T14:26:17.615257+03:00",
      "reason": ""
    },
    {
      "type": "logout",
      "phone": "79765656542",
      "created_at": "2026-02-19T14:25:16.919082+03:00",
      "reason": ""
    },
    {
      "type": "login",
      "phone": "79765656542",
      "created_at": "2026-02-19T14:19:15.688593+03:00",
      "reason": ""
    }
  ],
  "status": "done"
}
POSTАвторизовать по телефону: передача телефона/maxapi/sync/auth/phone

URL: https://wappi.pro/maxapi/sync/auth/phone?profile_id={{profile_id}}

Описание метода

Метод для авторизации в Max по номеру телефона. Позволяет получить код для авторизации с неавторизованного профиля, передав номер телефона.

Request Body

ПараметрТип данныхОбяз.Описание
phonestringДаНомер телефона для авторизации. Код приходит в смс. Например 79110000000
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "phone": "79110000000"
}
Responses
Авторизовать по телефону: передача телефона200
{
  "status": "done",
  "timestamp": 0,
  "time": "2026-06-30T11:23:07+03:00",
  "detail": "sms_code",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-06-30T11:23:07.158309959+03:00",
  "uuid": "15396b7f-4263"
}
POSTАвторизовать по телефону: ввести код авторизации/maxapi/sync/auth/code

URL: https://wappi.pro/maxapi/sync/auth/code?profile_id={{profile_id}}

Описание метода

Метод позволяет ввести код для авторизации, чтобы авторизоваться в Max по номеру телефона.

Request Body

ПараметрТип данныхОбяз.Описание
auth_codestringДаКод авторизации из SMS
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "auth_code": "684292"
}
Responses
Авторизовать по телефону: ввести код авторизации200
{
  "status": "done",
  "timestamp": 0,
  "time": "2026-07-17T16:32:03+03:00",
  "detail": "2fa",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-07-17T16:32:03.595637005+03:00",
  "uuid": "",
  "hint": "",
  "email": ""
}
Работа с сообщениями / Синхронные методы13 методов
POSTОтправить текстовое сообщение/maxapi/sync/message/send

URL: https://wappi.pro/maxapi/sync/message/send?profile_id={{profile_id}}&bot_id=18383820&ttl=600

Описание метода

Отправка текстового сообщения.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор существующего чата. Имеет приоритет над recipient. Пример: "-12307927"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
bodystringДаТекст сообщения. Пример: "Привет! Как ты?"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
ttl600Необязательный параметр. Задаёт максимальное время жизни команды (в секундах), в течение которого система будет пытаться доставить сообщение. Если за это время сообщение не было отправлено — оно отменяется и не отправляется повторно.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79602763846",
  "chat_id": "-71254750819698",
  "user_id": 5372054,
  "body": "Привет! Как ты? Что нового?",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить текстовое сообщение200
{
  "status": "done",
  "timestamp": 1772784680,
  "time": "2026-03-06T11:11:20+03:00",
  "detail": "Message sent successfully",
  "task_id": "e1d43511948cf1c588a3ff89b627f447",
  "command_start": "2026-03-06T11:11:20.525822354+03:00",
  "command_end": "2026-03-06T11:11:20.591227699+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116181216826565519"
}
POSTОтправить медиа по ссылке/maxapi/async/message/file/url/send

URL: https://wappi.pro/maxapi/async/message/file/url/send?profile_id={{profile_id}}&bot_id=163628382&ttl=600

Описание метода

Отправка сообщения с изображением, видео или документом. К изображению или видео можно добавить подпись. К документу можно добавить имя файла.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата. Используется для отправки сообщения в существующий чат. Имеет приоритет над recipient.Пример: "-2125475081969"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
urlstringДаПрямая ссылка на файл (изображение, видео или документ), доступная для скачивания сервером. Пример: "https://example.com/file.pdf"
file_namestringНетИмя файла
Используется для документов
captionstringНетПодпись к медиафайлу.
Используется для изображений и видео. Пример: "Медиа по ссылке"
as_filebooleanНетОтправить медиа как файл.
Используется для изображений и видео, позволяет выбрать отправлять как файл или нет. Пример: true
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id163628382Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
ttl600Необязательный параметр. Задаёт максимальное время жизни команды (в секундах), в течение которого система будет пытаться доставить сообщение. Если за это время сообщение не было отправлено — оно отменяется и не отправляется повторно.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79639486243",
  "chat_id": "-71254750819698",
  "user_id": 5372034,
  "url": "https://i.pinimg.com/736x/5e/11/5e/5e115ed0dd799a2f44f735af96ec225a.jpg",
  "file_name": "Имя файла",
  "caption": "Подпись к файлу",
  "as_file": true,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить медиа по ссылке200
{
  "status": "done",
  "timestamp": 1772784208,
  "time": "2026-03-06T11:03:28+03:00",
  "detail": "Message sent to queue",
  "task_id": "3b3080bb71515c58302b5368c3dbec9f",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": "15396b7f-4263"
}
POSTОтметить сообщение прочитанным/maxapi/sync/message/mark/read

URL: https://wappi.pro/maxapi/sync/message/mark/read?profile_id={{profile_id}}

Описание метода

Метод позволяет отметить сообщение прочитанным.

Request Body

ПараметрТип данныхОбяз.Описание и пример
message_idstringДаИдентификатор сообщения, которое необходимо отметить как прочитанное. Пример: "3085"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "message_id": "116158580677630247"
}
Responses
Отметить сообщение прочитанным200
{
  "status": "done",
  "timestamp": 1771504047,
  "time": "2026-02-19T15:27:27+03:00",
  "detail": "Messages marked as read successfully",
  "task_id": "e737ff44db9e6d6ef89a63f691a96116",
  "command_start": "2026-02-19T15:27:27.797327607+03:00",
  "command_end": "2026-02-19T15:27:27.978478432+03:00",
  "uuid": "15396b7f-4263"
}
POSTОтправить реакцию на сообщение/maxapi/sync/message/reaction

URL: https://wappi.pro/maxapi/sync/message/reaction?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Отправка реакции на сообщение. Повторный вызов метода, если в параметре body передано новое значение, изменяет реакцию.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется реакция.

Request Body

ПараметрТип данныхОбяз.Описание и пример
bodystringДаРеакция в виде одного эмодзи. Пример: "👍"
message_idstringДаИдентификатор сообщения, на которое отправляется реакция. Пример: "132132132123132132132"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "body": "👍",
  "message_id": "116158580677630247",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить реакцию на сообщение200
{
  "status": "done",
  "timestamp": 1772785045,
  "time": "2026-03-06T11:17:25+03:00",
  "detail": "Reaction set successfully",
  "task_id": "1f646ee7ce50db4c5065d8390ed3b320",
  "command_start": "2026-03-06T11:17:25.893223744+03:00",
  "command_end": "2026-03-06T11:17:25.952880184+03:00",
  "uuid": "15396b7f-4263"
}
POSTОтветить на сообщение/maxapi/sync/message/reply

URL: https://wappi.pro/maxapi/sync/message/reply?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Метод позволяет отправить ответ на конкретное сообщение. Если в теле запроса указано поле url, будет отправлено сообщение с файлом. Если поле url отсутствует, отправляется текстовый ответ.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
bodystringУсловноТекст ответа.
Пример: "тестовый ответ на сообщение"
message_idstringДаИдентификатор сообщения, на которое отправляется ответ. Пример: "114998436624933775"
urlstringУсловноПрямая ссылка на файл для отправки вместе с ответом. Если поле отсутствует, отправляется только текст. Пример: "https://example.com/file.jpg"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен как минимум один из параметров: body или url. Допустимо использование двух параметров одновременно.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "body": "тестовый ответ на сообщение",
  "message_id": "116136317123974440",
  "url": "https://img.freepik.com/free-photo/cute-kitten-sitting-staring-playful-fluffy-looking-camera-generated-by-artificial-intelligence_188544-113029.jpg?semt=ais_hybrid&w=740",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Ответить на сообщение200
{
  "status": "done",
  "timestamp": 1772792734,
  "time": "2026-03-06T13:25:34+03:00",
  "detail": "Reply message sent successfully",
  "task_id": "311a33e90cbb1c9ad85acdab7611b5df",
  "command_start": "2026-03-06T13:25:33.630768599+03:00",
  "command_end": "2026-03-06T13:25:34.045627437+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116181744607703486"
}
POSTИзменить сообщение/maxapi/sync/message/edit

URL: https://wappi.pro/maxapi/sync/message/edit?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Метод позволяет изменить текст ранее отправленного сообщения. При необходимости можно заменить прикреплённый к сообщению файл, передав параметр url.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого изменяется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
bodystringУсловноНовый текст сообщения. Пример: "Измененное сообщение"
urlstringУсловноСсылка на новый файл, если требуется заменить вложение. Пример: "https://example.com/file.jpg"
message_idstringДаИдентификатор сообщения, которое необходимо изменить. Пример: "3079"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен как минимум один из параметров: body или url. Параметры могут быть переданы одновременно. При изменении вложения (url) текст исходного сообщения не сохраняется автоматически. Для сохранения текста его необходимо повторно передать в параметре body.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "body": "Измененное сообщение",
  "url": "https://img.freepik.com/free-photo/cute-kitten-sitting-staring-playful-fluffy-looking-camera-generated-by-artificial-intelligence_188544-113029.jpg",
  "message_id": "116155034852547211",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Изменить сообщение200
{
  "status": "done",
  "timestamp": 1772792762,
  "time": "2026-03-06T13:26:02+03:00",
  "detail": "Message edited successfully",
  "task_id": "923933bd8e73cfba4c4b0a38787e922c",
  "command_start": "2026-03-06T13:26:02.206168862+03:00",
  "command_end": "2026-03-06T13:26:02.766814588+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116155034852547211"
}
POSTПереслать сообщение/maxapi/sync/message/forward

URL: https://wappi.pro/maxapi/sync/message/forward?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Метод позволяет переслать ранее полученное или отправленное сообщение другому получателю.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
message_idstringДаИдентификатор сообщения, которое необходимо переслать.Пример: "116097585839898064"
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата. Используется для отправки сообщения в существующий чат. Имеет приоритет над recipient.Пример: "-2125475081969"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "message_id": "116148440525051227",
  "recipient": "79522345680",
  "chat_id": "-71254750819698",
  "user_id": 5372054,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Переслать сообщение200
{
  "status": "done",
  "timestamp": 1772284564,
  "time": "2026-02-28T16:16:04+03:00",
  "detail": "Message forwarded successfully",
  "task_id": "2abb05aa07cfe4c4147fdd1dc59907da",
  "command_start": "2026-02-28T16:16:04.271698776+03:00",
  "command_end": "2026-02-28T16:16:04.419473858+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116148441213904078"
}
POSTОтправить локацию/maxapi/sync/message/location/send

URL: https://wappi.pro/maxapi/sync/message/location/send?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Отправка геолокации.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата Имеет приоритет над recipient.Пример: "-71254750819698"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
latitudenumberДаШирота
Десятичные градусы. Пример: 55.750446
longitudenumberДаДолгота
Десятичные градусы. Пример: 37.617494
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79115576367",
  "chat_id": "-71254750819698",
  "user_id": 5372043,
  "latitude": 55.750446,
  "longitude": 37.617494,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить локацию200
{
  "status": "done",
  "timestamp": 1772789429,
  "time": "2026-03-06T12:30:29+03:00",
  "detail": "Location sent successfully",
  "task_id": "0b92f6a0b24adb212efbe6a01f8f4457",
  "command_start": "2026-03-06T12:30:28.978471614+03:00",
  "command_end": "2026-03-06T12:30:29.063953427+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116181528022221235"
}
POSTОтправить контакт/maxapi/sync/contact/send

URL: https://wappi.pro/maxapi/sync/contact/send?profile_id={{profile_id}}&bot_id=18383820

Описание метода

Отправка контакта.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
phonestringДаНомер телефона передаваемого контакта Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Примеры: "79115556677"
namestringНетИмя контакта, которое будет отображаться у получателя. Пример: "Имя контакта"
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Примеры: "79115556677"
chat_idstringУсловноИдентификатор чата для отправки контакта. Имеет приоритет над recipient.Пример: "71219698"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условие обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "phone": "79387475656",
  "recipient": "79769879898",
  "chat_id": "-71254750819698",
  "user_id": 5372043,
  "name": "Имя контакта",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить контакт200
{
  "status": "done",
  "timestamp": 1772789551,
  "time": "2026-03-06T12:32:31+03:00",
  "detail": "Contact sent successfully",
  "task_id": "20009549779908ecaee4b547eff8401e",
  "command_start": "2026-03-06T12:32:31.010883784+03:00",
  "command_end": "2026-03-06T12:32:31.223714541+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116181536028101218"
}
POSTУдалить сообщение/maxapi/sync/message/delete

URL: https://wappi.pro/maxapi/sync/message/delete?profile_id={{profile_id}}

Описание метода

Удаление сообщения.

Request Body

ПараметрТип данныхОбяз.Описание и пример
message_idstringДаИдентификатор сообщения, которое необходимо удалить
Пример: "116102904933976674"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "message_id": "116102904933976674"
}
Responses
Удалить сообщение200
{
  "status": "done",
  "timestamp": 1771590521,
  "time": "2026-02-20T15:28:41+03:00",
  "detail": "Message deleted successfully",
  "task_id": "8be834577b7b20d712a3c9bb98f86d45",
  "command_start": "2026-02-20T15:28:40.40293792+03:00",
  "command_end": "2026-02-20T15:28:41.059439643+03:00",
  "uuid": "15396b7f-4263"
}
GETПолучить сообщения из чата/maxapi/sync/messages/get

URL: https://wappi.pro/maxapi/sync/messages/get?profile_id={{profile_id}}&chat_id=-71254750819698&limit=2&date=2024-02-22T15:50:51&offset=0&mark_all=true&order=desc

Описание метода

Получение сообщений из конкретного чата.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
chat_id-71254750819698Обязательный параметр. ID чата из списка сообщений.
limit2Необязательный параметр. Количество сообщений для получения. Если не указывать, то по умолчанию установлено значение 100. Максимальное значение 100.
date2024-02-22T15:50:51Необязательный параметр. Дата, с которой вывести список сообщений. Формат YYYY-mm-ddTHH:MM:ss (например 2023-12-31T12:00:00).
offset0Необязательный параметр. От какого по счету элемента вывести список сообщений, где 0 это самое новое сообщение. Если не указывать, то по умолчанию установлено значение 0.
mark_alltrueНеобязательный параметр. Значения true или false. Если true, то помечает все непрочитанные сообщения в чате прочитанными. Если не указывать, то по умолчанию стоит значение false. Работает только для личных чатов, для групп не работает.
orderdescНеобязательный параметр. Значения desc или asc. Если desc - сортирует от новых к старым, если asc - от старых к новым. Если не указывать, то по умолчанию стоит desc
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить сообщения из чата200
{
  "status": "done",
  "timestamp": 1772470744,
  "time": "2026-03-02T19:59:04+03:00",
  "detail": "Successfully fetched 2 messages (hasMore: true)",
  "task_id": "7fbfec7f6904ba7f59e6b88b5b1c42dc",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-03-02T19:59:04.149632167+03:00",
  "uuid": "15396b7f-4263",
  "messages": [
    {
      "id": "116158580677630247",
      "type": "text",
      "from": "79116543434",
      "to": "-71254750819698",
      "fromMe": true,
      "senderName": "erva",
      "contact_name": "гг",
      "username": "",
      "phone": "79116543434",
      "time": 1772439280359,
      "body": "Привет! Как ты? Что нового?",
      "stanzaId": "",
      "chatId": "-71254750819698",
      "isForwarded": false,
      "isReply": false,
      "caption": "",
      "file_name": "",
      "isRead": false,
      "delivery_status": "read",
      "s3Info": {},
      "poll_votes": null,
      "mimetype": "",
      "from_where": "api",
      "isEdited": false,
      "isGif": false,
      "isFromAPI": true,
      "isDeleted": false,
      "location": null,
      "isPinned": false,
      "reactions": [
        {
          "reaction": "👍",
          "count": 1,
          "user_id": "15349106",
          "contact_name": "erva",
          "type": "add"
        }
      ],
      "wappi_bot_id": "",
      "task_id": "9ff09c9a5dd7e24102f80eb860e5a429",
      "template_id": "",
      "manager": {
        "id": "38200203",
        "name": "Светлана",
        "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
        "description": "описание пример"
      },
      "crm_entities": {
        "crm_type": "",
        "crm_id": "",
        "message_id": "",
        "chat_id": "",
        "manager_id": ""
      },
      "is_blacklist": false,
      "billable": false,
      "attaches": null
    },
    {
      "id": "116155047953199354",
      "type": "vcard",
      "from": "79116543434",
      "to": "-71254750819698",
      "fromMe": true,
      "senderName": "erva",
      "contact_name": "",
      "username": "",
      "phone": "79116543434",
      "time": 1772385375262,
      "body": [
        {
          "Key": "displayname",
          "Value": "Имя контакта "
        },
        {
          "Key": "phone",
          "Value": ""
        },
        {
          "Key": "vcard",
          "Value": "BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:ez-vcard 0.10.3\r\nTEL;TYPE=CELL,VOICE,pref:\r\nFN:Имя контакта \r\nEND:VCARD\r\n"
        }
      ],
      "stanzaId": "",
      "chatId": "-71254750819698",
      "isForwarded": false,
      "isReply": false,
      "caption": "",
      "file_name": "",
      "isRead": false,
      "delivery_status": "read",
      "s3Info": {},
      "poll_votes": null,
      "mimetype": "",
      "from_where": "api",
      "isEdited": false,
      "isGif": false,
      "isFromAPI": true,
      "isDeleted": false,
      "location": null,
      "isPinned": false,
      "reactions": null,
      "wappi_bot_id": "",
      "task_id": "d9be0aafe2ad1ae191c8d5eeb4408c77",
      "template_id": "",
      "manager": {
        "id": "38200203",
        "name": "Светлана",
        "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
        "description": "описание пример"
      },
      "crm_entities": {
        "crm_type": "",
        "crm_id": "",
        "message_id": "",
        "chat_id": "",
        "manager_id": ""
      },
      "contact": {
        "display_name": "Имя контакта ",
        "vcard": "BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:ez-vcard 0.10.3\r\nTEL;TYPE=CELL,VOICE,pref:\r\nFN:Имя контакта \r\nEND:VCARD\r\n"
      },
      "is_blacklist": false,
      "billable": false,
      "attaches": null
    }
  ],
  "has_more": true
}
GETПолучить сообщение по ID/maxapi/sync/messages/id/get

URL: https://wappi.pro/maxapi/sync/messages/id/get?profile_id={{profile_id}}&message_id=114997934844772126

Описание метода

Получение конкретного сообщения.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
message_id114997934844772126Обязательный параметр. ID сообщения
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить сообщение по ID200
{
  "status": "done",
  "timestamp": 1771594539,
  "time": "2026-02-20T16:35:39+03:00",
  "detail": "Successfully fetched message",
  "task_id": "188400dc21f0694e589ab0c912bc2048",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-20T16:35:39.061682352+03:00",
  "uuid": "15396b7f-4263",
  "message": {
    "id": "116103215172438421",
    "type": "document",
    "from": "79522536474",
    "to": "79602876553",
    "fromMe": true,
    "senderName": "Оксана",
    "contact_name": "Виктор",
    "username": "",
    "phone": "79522536474",
    "time": 1771594469794,
    "body": "",
    "stanzaId": "",
    "chatId": "12307927",
    "isForwarded": false,
    "isReply": false,
    "caption": "",
    "file_name": "таблица.xml",
    "isRead": false,
    "delivery_status": "",
    "s3Info": {
      "url": "https://wapi-uploads3d.storage.yandexcloud.net/15396b7f-4263/%D1%82%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D0%B0.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=YCAJEx61R4C7kz0v5oC6y60Gx%2F20260220%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20260220T133449Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=f9a04f121b80cb3aae063d5ca03585e3c315a31bacc463c23c2990fa0eaddffb",
      "expire": 1771853689
    },
    "poll_votes": null,
    "mimetype": "",
    "from_where": "phone",
    "isEdited": false,
    "isGif": false,
    "isFromAPI": true,
    "isDeleted": false,
    "location": null,
    "isPinned": false,
    "reactions": null,
    "media_info": {
      "width": 0,
      "height": 0,
      "size": 0,
      "duration": 0,
      "is_round": false,
      "is_group": false,
      "grouped_id": ""
    },
    "wappi_bot_id": "",
    "task_id": "",
    "template_id": "",
    "crm_entities": {
      "crm_type": "",
      "crm_id": "",
      "message_id": "",
      "chat_id": "",
      "manager_id": ""
    },
    "is_blacklist": false,
    "billable": false,
    "attaches": [
      {
        "id": "116103215172438420_FILE",
        "type": "FILE",
        "url": "https://wapi-uploads7d.storage.yandexcloud.net/15396b7f-4263/%D1%82%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D0%B0%2811%29.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=YCAJEx61R4C7kz0v5oC6y60Gx%2F20260220%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20260220T133430Z&X-Amz-Expires=172800&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=339009f469fed59134a92e7bb5802993ac89142ae19f172a2fe4d4abf587b968",
        "caption": "",
        "mimetype": "",
        "file_name": "таблица.xml",
        "size": 3423
      }
    ]
  }
}
GETСкачать медиа из сообщения/maxapi/sync/message/media/download

URL: https://wappi.pro/maxapi/sync/message/media/download?profile_id={{profile_id}}&message_id=5880

Описание метода

Метод позволяет скачать файл из конкретного сообщения.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
message_id5880Обязательный параметр. ID сообщения, из которого необходимо скачать файл
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Скачать медиа из сообщения200
{
  "status": "done",
  "timestamp": 1771594489,
  "time": "2026-02-20T16:34:49+03:00",
  "detail": "Media downloaded successfully: таблица.xml",
  "task_id": "2c00d494bb6798690d55a78da67ec909",
  "command_start": "2026-02-20T16:34:48.910184976+03:00",
  "command_end": "2026-02-20T16:34:49.226809399+03:00",
  "uuid": "15396b7f-4263",
  "file_link": "https://wapi-uploads3d.storage.yandexcloud.net/15396b7f-4263/%D1%82%D0%B0%D0%B1%D0%BB%D0%B8%D1%86%D0%B0.xml?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=YCAJEx61R4C7kz0v5oC6y60Gx%2F20260220%2Fru-central1%2Fs3%2Faws4_request&X-Amz-Date=20260220T133449Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&x-id=GetObject&X-Amz-Signature=f9a04f121b80cb3aae063d5ca03585e3c315a31bacc463c23c2990fa0eaddffb",
  "file_link_expire": 1771853689
}
Работа с сообщениями / Асинхронные методы6 методов
POSTОтправить текстовое сообщение/maxapi/async/message/send

URL: https://wappi.pro/maxapi/async/message/send?profile_id={{profile_id}}&timeout_from=1&timeout_to=3&bot_id=1&ttl=600

Описание метода

Отправка текстового сообщения.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор существующего чата. Имеет приоритет над recipient. Пример: "-12307927"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
bodystringДаТекст сообщения. Пример: "Привет! Как ты?"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
bot_id1Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке. Например информацией о сервисе-источнике запроса.
ttl600Необязательный параметр. Задаёт максимальное время жизни команды (в секундах), в течение которого система будет пытаться доставить сообщение. Если за это время сообщение не было отправлено — оно отменяется и не отправляется повторно.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79118276363",
  "chat_id": "-71254750819698",
  "user_id": 5372659,
  "body": "Привет! Как ты? Что нового?",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить текстовое сообщение200
{
  "status": "done",
  "timestamp": 1772790494,
  "time": "2026-03-06T12:48:14+03:00",
  "detail": "Message sent to queue",
  "task_id": "60955b93617518577b76e613a1ce5b01",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": ""
}
POSTОтправить медиа по ссылке/maxapi/async/message/file/url/send

URL: https://wappi.pro/maxapi/async/message/file/url/send?profile_id={{profile_id}}&bot_id=1&timeout_from=1&timeout_to=3&ttl=600

Описание метода

Отправка сообщения с изображением, видео или документом. К изображению или видео можно добавить подпись. К документу можно добавить имя файла.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата. Используется для отправки сообщения в существующий чат. Имеет приоритет над recipient.Пример: "-2125475081969"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
urlstringДаПрямая ссылка на файл (изображение, видео или документ), доступная для скачивания сервером. Пример: "https://example.com/file.pdf"
file_namestringНетИмя файла
Используется для документов
captionstringНетПодпись к медиафайлу.
Используется для изображений и видео. Пример: "Медиа по ссылке"
as_filebooleanНетОтправить медиа как файл.
Используется для изображений и видео, позволяется выбрать отправлять как файл или нет. Пример: true
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
bot_id1Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке. Например информацией о сервисе-источнике запроса.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
ttl600Необязательный параметр. Задаёт максимальное время жизни команды (в секундах), в течение которого система будет пытаться доставить сообщение. Если за это время сообщение не было отправлено — оно отменяется и не отправляется повторно.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79639486243",
  "chat_id": "-71254750819698",
  "user_id": 5372659,
  "url": "https://disk.sample.cat/samples/xml/sample-1.xml",
  "file_name": "таблица.xml",
  "caption": "Медиа по ссылке",
  "as_file": true,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить медиа по ссылке200
{
  "status": "done",
  "timestamp": 1772790587,
  "time": "2026-03-06T12:49:47+03:00",
  "detail": "Message sent to queue",
  "task_id": "5667b6b37a8de92d175bd120223618bf",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": "15396b7f-4263"
}
POSTОтправить локацию/maxapi/async/message/location/send

URL: https://wappi.pro/maxapi/async/message/location/send?profile_id={{profile_id}}&timeout_from=1&timeout_to=3&bot_id=1

Описание метода

Отправка геолокации.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата Имеет приоритет над recipient.Пример: "-71254750819698"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
latitudenumberДаШирота
Десятичные градусы. Пример: 55.750446
longitudenumberДаДолгота
Десятичные градусы. Пример: 37.617494
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
bot_id1Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке. Например информацией о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79815432736",
  "chat_id": "-71254750819698",
  "user_id": 5372559,
  "latitude": 55.750446,
  "longitude": 37.617494,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить локацию200
{
  "status": "done",
  "timestamp": 1772790651,
  "time": "2026-03-06T12:50:51+03:00",
  "detail": "Message sent to queue",
  "task_id": "5a05289bf1fa6d7455d26782fe3ffac9",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": ""
}
POSTОтправить контакт/maxapi/async/contact/send

URL: https://wappi.pro/maxapi/async/contact/send?profile_id={{profile_id}}&timeout_from=1&timeout_to=3&bot_id=1

Описание метода

Отправка контакта.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
phonestringДаНомер телефона передаваемого контакта Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Примеры: "79115556677"
namestringНетИмя контакта, которое будет отображаться у получателя. Пример: "Имя контакта"
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Примеры: "79115556677"
chat_idstringУсловноИдентификатор чата для отправки контакта. Имеет приоритет над recipient.Пример: "71219698"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
bot_id1Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке. Например информацией о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "phone": "79632341981",
  "recipient": "79839487565",
  "chat_id": "-71254750819698",
  "user_id": 5372559,
  "name": "Имя контакта",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Отправить контакт200
{
  "status": "done",
  "timestamp": 1772790724,
  "time": "2026-03-06T12:52:04+03:00",
  "detail": "Message sent to queue",
  "task_id": "17cfd63dc3584bbe8910d960626bb9db",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": ""
}
POSTПереслать сообщение/maxapi/async/message/forward

URL: https://wappi.pro/maxapi/async/message/forward?profile_id={{profile_id}}&timeout_from=1&timeout_to=3&bot_id=1

Описание метода

Метод позволяет переслать ранее полученное или отправленное сообщение другому получателю.

Сообщение может быть отправлено как по recipient (телефон), так и по chat_id (идентификатор чата) или user_id (идентификатор пользователя) которые указываются в Body. Если указаны все три, то приоритет будет у user_id.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
message_idstringДаИдентификатор сообщения, которое необходимо переслать.Пример: "116097585839898064"
recipientstringУсловноНомер получателя сообщения. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
chat_idstringУсловноИдентификатор чата. Используется для отправки сообщения в существующий чат. Имеет приоритет над recipient.Пример: "-2125475081969"
user_idnumberУсловноИдентификатор существующего пользователя. Имеет приоритет над chat_id. Идентификатор пользователя можно получить из ответов методов (например contact.id в методе "Получить контакт") или вебхуков (например contact_max_user_id в вебхуке с типом outgoing_message_api). Пример: 5372054
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен один из параметров: recipient или chat_id или user_id. Если указано несколько параметров одновременно, используется следующий приоритет: user_idchat_idrecipient

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
bot_id1Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке. Например информацией о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "message_id": "116136317123974440",
  "recipient": "79602432312",
  "chat_id": "-71254750819698",
  "user_id": 5372559,
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Переслать сообщение200
{
  "status": "done",
  "timestamp": 1772790862,
  "time": "2026-03-06T12:54:22+03:00",
  "detail": "Message sent to queue",
  "task_id": "41c6ca3d5a770ccab8ea599026ea1aec",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": ""
}
POSTОтветить на сообщение/maxapi/async/message/reply

URL: https://wappi.pro/maxapi/async/message/reply?profile_id={{profile_id}}&timeout_from=1&timeout_to=3&bot_id=18383820

Описание метода

Метод позволяет отправить ответ на конкретное сообщение. Если в теле запроса указано поле url, будет отправлено сообщение с файлом. Если поле url отсутствует, отправляется текстовый ответ.

Дополнительно может быть передан объект manager — информация о менеджере, от имени которого отправляется сообщение.

Request Body

ПараметрТип данныхОбяз.Описание и пример
bodystringУсловноТекст ответа.
Пример: "тестовый ответ на сообщение"
message_idstringДаИдентификатор сообщения, на которое отправляется ответ.Пример: "114998436624933775"
urlstringУсловноПрямая ссылка на файл для отправки вместе с ответом. Если поле отсутствует, отправляется только текст. Пример: "https://example.com/file.jpg"
managerobjectНетОбъект с информацией о менеджере, от имени которого отправляется сообщение.
manager.idstringНетИдентификатор менеджера. Пример: "38200203"
manager.namestringНетИмя менеджера. Пример: "Светлана"
manager.ava_linkstringНетСсылка на аватар менеджера. Пример: "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg"
manager.descriptionstringНетОписание. Любая необходимая дополнительная информация

Условия обязательности: обязателен как минимум один из параметров: body или url. Допустимо использование двух параметров одновременно.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
timeout_from1Необязательный параметр. Минимальное время задержки, указывается в секундах
timeout_to3Необязательный параметр. Максимальное время задержки, указывается в секундах
bot_id18383820Необязательный параметр. Заполняется необходимыми мета-данными, которые будут получены в вебхуке на исходящее сообщение по API. Например информация о сервисе-источнике запроса.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "body": "тестовый ответ на сообщение",
  "message_id": "116136317123974440",
  "url": "https://img.freepik.com/free-photo/cute-kitten-sitting-staring-playful-fluffy-looking-camera-generated-by-artificial-intelligence_188544-113029.jpg?semt=ais_hybrid&w=740",
  "manager": {
    "name": "Светлана",
    "id": "38200203",
    "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
    "description": "описание пример"
  }
}
Responses
Ответить на сообщение200
{
  "status": "done",
  "timestamp": 1772790904,
  "time": "2026-03-06T12:55:04+03:00",
  "detail": "Message sent to queue",
  "task_id": "2e56b189ec916b62826cb38fe627eb30",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": ""
}
Работа с чатами5 методов
POSTПолучить список чатов/maxapi/sync/chats/get

URL: https://wappi.pro/maxapi/sync/chats/get?profile_id={{profile_id}}&limit=3&show_all=false&offset=0&order=desc

Описание метода

Получение списка всех чатов в подключенном аккаунте Max.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
limit3Необязательный параметр. Количество чатов для получения. Если не указывать, то по умолчанию установлено значение 200.
show_allfalseНеобязательный параметр. Позволяет получить все чаты. Значение может быть true или false. Если не указывать параметр, то по умолчанию false.
offset0Необязательный параметр. Определяет от какого по счету элемента вывести список чатов, где 0 это самый новый чат. Если не указывать, то по умолчанию установлено значение 0.
orderdescНеобязательный параметр. Значения desc или asc. Если desc - сортирует от новых к старым, если asc - от старых к новым. Если не указывать, то по умолчанию стоит desc
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить список чатов200
{
  "status": "done",
  "timestamp": 1772312897,
  "time": "2026-03-01T00:08:17+03:00",
  "detail": "Chats fetched",
  "task_id": "",
  "command_start": "2026-03-01T00:08:17.284441794+03:00",
  "command_end": "2026-03-01T00:08:17.297524576+03:00",
  "uuid": "15396b7f-4263",
  "dialogs": [
    {
      "id": "205160429",
      "type": "DIALOG",
      "isGroup": false,
      "image": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotN-9L5XE70IkEJTdjoKLx3h3lgMsSZV0bvElZIkv3kBQ",
      "thumbnail": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotN-9L5XE70IkEJTdjoKLx3h3lgMsSZV0bvElZIkv3kBQ",
      "avatar_updated_at": 0,
      "last_message_delivery_status": "",
      "last_message_id": "116148674465001269",
      "last_timestamp": 1772288123550,
      "last_message_type": "text",
      "last_message_sender": {
        "id": "",
        "number": "",
        "pushname": "",
        "isMe": false
      },
      "last_message_data": "📎 Вложение",
      "name": "Анна",
      "unread_count": 0,
      "wapi_unread_count": 0,
      "isDeleted": false,
      "isArchived": false,
      "item_name": "",
      "item_link": "",
      "is_wappi_pinned": false,
      "participants": [
        {
          "user_id": "15349106",
          "is_admin": true,
          "is_creator": true,
          "name": "",
          "username": "",
          "phone": "",
          "is_bot": false,
          "is_me": true,
          "inviter_id": "",
          "invite_timestamp": 1772288123549
        },
        {
          "user_id": "214977183",
          "is_admin": false,
          "is_creator": false,
          "name": "",
          "username": "",
          "phone": "",
          "is_bot": false,
          "is_me": false,
          "inviter_id": "",
          "invite_timestamp": 0
        }
      ],
      "phone": "79116265432",
      "manager": {
        "id": "",
        "name": "",
        "ava_link": "",
        "description": ""
      }
    }
  ],
  "total_count": 53
}
GETПолучить список чатов с фильтром/maxapi/sync/chats/filter

URL: https://wappi.pro/maxapi/sync/chats/filter?profile_id={{profile_id}}&client_name=7960

Описание метода

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

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
client_name7960Необязательный параметр. Можно указать часть номера или слова для фильтрации по номеру телефона, имени чата и последнему сообщению чата.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw

Тело запроса не передается.

Responses
Получить список чатов с фильтром200
{
  "status": "done",
  "timestamp": 1773649423,
  "time": "2026-03-16T11:23:43+03:00",
  "detail": "Chats fetched",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": "",
  "dialogs": [
    {
      "id": "224449775",
      "type": "DIALOG",
      "isGroup": false,
      "image": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NottOVnIJkY9NIc-al2fTUZvB3lgMsSZV0bvElZIkv3kBQ",
      "thumbnail": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NottOVnIJkY9NIc-al2fTUZvB3lgMsSZV0bvElZIkv3kBQ",
      "avatar_updated_at": 0,
      "last_message_delivery_status": "",
      "last_message_id": "116234258672414517",
      "last_timestamp": 1773594034918,
      "last_message_type": "text",
      "last_message_sender": {
        "id": "",
        "number": "",
        "pushname": "",
        "isMe": false
      },
      "last_message_data": "📎 Вложение",
      "name": "Антикошка сетки на окна",
      "unread_count": 0,
      "wapi_unread_count": 0,
      "isDeleted": false,
      "isArchived": false,
      "item_name": "",
      "item_link": "",
      "is_wappi_pinned": false,
      "participants": [
        {
          "user_id": "15349106",
          "is_admin": true,
          "is_creator": true,
          "name": "",
          "username": "",
          "phone": "",
          "is_bot": false,
          "is_me": true,
          "inviter_id": "",
          "invite_timestamp": 1773594034917
        },
        {
          "user_id": "227205533",
          "is_admin": false,
          "is_creator": false,
          "name": "Антикошка сетки на окна",
          "username": "",
          "phone": "79156736464",
          "is_bot": false,
          "is_me": false,
          "inviter_id": "",
          "invite_timestamp": 0
        }
      ],
      "phone": "79156736464",
      "manager": {
        "id": "",
        "name": "",
        "ava_link": "",
        "description": ""
      }
    }
  ],
  "total_count": 1
}
GETПолучить список чатов по дням/maxapi/sync/chats/days/get

URL: https://wappi.pro/maxapi/sync/chats/days/get?profile_id={{profile_id}}&offset=0&limit=7&order=desc&is_archived=true&is_deleted=true

Описание метода

Получение списка всех чатов в подключенном аккаунте MAX с использованием фильтрации по количеству дней в выборке, которое указывается в параметре limit. Если не указывать, то по умолчанию установлено значение 20.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
offset0Необязательный параметр. Отступ от текущего момента в днях. Если не указывать, то по умолчанию установлено значение 0.
limit7Необязательный параметр. Количество дней в выборке. Если не указывать, то по умолчанию установлено значение 20.
orderdescНеобязательный параметр. Сортировка. Возможные варианты asc и desc. По умолчанию desc
is_archivedtrueНеобязательный параметр. Фильтр по архивным чатам. Возможные значения true и false. По умолчанию false.
is_deletedtrueНеобязательный параметр. Фильтр по удаленным чатам. Возможные значения true и false. По умолчанию false.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw

Тело запроса не передается.

Responses
Получить список чатов по дням200
{
  "status": "done",
  "timestamp": 1773734860,
  "time": "2026-03-17T11:07:40+03:00",
  "detail": "Chats fetched",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "0001-01-01T00:00:00Z",
  "uuid": "",
  "dialogs": [
    {
      "id": "223439692",
      "type": "DIALOG",
      "isGroup": false,
      "image": "",
      "thumbnail": "",
      "avatar_updated_at": 0,
      "last_message_delivery_status": "",
      "last_message_id": "116242873116553013",
      "last_timestamp": 1773725480904,
      "last_message_type": "system",
      "last_message_sender": {
        "id": "",
        "number": "",
        "pushname": "",
        "isMe": false
      },
      "last_message_data": "Теперь в MAX!",
      "name": "Юлия Борисовна",
      "unread_count": 0,
      "wapi_unread_count": 0,
      "isDeleted": false,
      "isArchived": false,
      "item_name": "",
      "item_link": "",
      "is_wappi_pinned": false,
      "participants": [
        {
          "user_id": "15349106",
          "is_admin": true,
          "is_creator": true,
          "name": "",
          "username": "",
          "phone": "",
          "is_bot": false,
          "is_me": true,
          "inviter_id": "",
          "invite_timestamp": 1773725480903
        },
        {
          "user_id": "230383166",
          "is_admin": false,
          "is_creator": false,
          "name": "Юлия Борисовна",
          "username": "",
          "phone": "79817902510",
          "is_bot": false,
          "is_me": false,
          "inviter_id": "",
          "invite_timestamp": 0
        }
      ],
      "phone": "79817902510",
      "manager": {
        "id": "",
        "name": "",
        "ava_link": "",
        "description": ""
      }
    },
    {
      "id": "224449775",
      "type": "DIALOG",
      "isGroup": false,
      "image": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NottOVnIJkY9NIc-al2fTUZvB3lgMsSZV0bvElZIkv3kBQ",
      "thumbnail": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NottOVnIJkY9NIc-al2fTUZvB3lgMsSZV0bvElZIkv3kBQ",
      "avatar_updated_at": 0,
      "last_message_delivery_status": "",
      "last_message_id": "116234258672414517",
      "last_timestamp": 1773594034918,
      "last_message_type": "text",
      "last_message_sender": {
        "id": "",
        "number": "",
        "pushname": "",
        "isMe": false
      },
      "last_message_data": "📎 Вложение",
      "name": "Антикошка",
      "unread_count": 0,
      "wapi_unread_count": 0,
      "isDeleted": false,
      "isArchived": false,
      "item_name": "",
      "item_link": "",
      "is_wappi_pinned": false,
      "participants": [
        {
          "user_id": "15349106",
          "is_admin": true,
          "is_creator": true,
          "name": "",
          "username": "",
          "phone": "",
          "is_bot": false,
          "is_me": true,
          "inviter_id": "",
          "invite_timestamp": 1773648308479
        },
        {
          "user_id": "227205533",
          "is_admin": false,
          "is_creator": false,
          "name": "Антикошка",
          "username": "",
          "phone": "79156734943",
          "is_bot": false,
          "is_me": false,
          "inviter_id": "",
          "invite_timestamp": 0
        }
      ],
      "phone": "79156734943",
      "manager": {
        "id": "",
        "name": "",
        "ava_link": "",
        "description": ""
      }
    }
  ],
  "total_count": 2
}
POSTУстановить статус "печатает"/maxapi/sync/chats/typing/start

URL: https://wappi.pro/maxapi/sync/chats/typing/start?profile_id={{profile_id}}

Описание метода

Метод позволяет установить статус "печатает".

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringДаПолучатель сообщения (кто будет видеть "печатает..." в диалоге). В качестве значения можно указать номер телефона, идентификатор пользователя или идентификатор чата. Для номера телефона допускаются различные форматы записи (со знаком +, пробелами, скобками, дефисами). Для имени пользователя допускается указание как с символом @, так и без него. Примеры: "79115556677", "@testname", "testname", "123456789"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79110000000"
}
POSTПереименовать чат/maxapi/sync/chat/rename

URL: https://wappi.pro/maxapi/sync/chat/rename?profile_id={{profile_id}}

Описание метода

Метод предназначен для изменения названия чата в зависимости от его типа.

Request Body

ПараметрТип данныхОбяз.Описание и пример
chat_idstringДаИдентификатор чата, название которого необходимо изменить. Пример: "123456789"
namestringДаНовое название чата. Пример: "Новый название"

Для личного чата используется как новое имя контакта, для групп — как новое название.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "chat_id": "-76703593231730",
  "name": "Новое название"
}
Responses
Переименовать чат200
{
  "status": "done"
}
Работа с контактами5 методов
GETПолучить контакты/maxapi/sync/contacts/get

URL: https://wappi.pro/maxapi/sync/contacts/get?profile_id={{profile_id}}

Описание метода

Получение всех контактов авторизованного номера Max.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить контакты200
{
  "status": "done",
  "timestamp": 1772304896,
  "time": "2026-02-28T21:54:56+03:00",
  "detail": "Successfully retrieved contacts",
  "task_id": "e1355488ae7ebbb20b59624090291beb",
  "command_start": "2026-02-28T21:54:56.319915879+03:00",
  "command_end": "2026-02-28T21:54:56.206904089+03:00",
  "uuid": "15396b7f-4263",
  "contacts": [
    {
      "id": 40081123,
      "accountStatus": 0,
      "names": [
        {
          "name": "Унаватуна 1",
          "firstName": "Унаватуна 1",
          "lastName": "",
          "type": "CUSTOM"
        },
        {
          "name": "Настя",
          "firstName": "Настя",
          "lastName": "",
          "type": "ONEME"
        }
      ],
      "phone": 79126573920,
      "options": [
        "TT",
        "ONEME"
      ],
      "updateTime": 1755888050835,
      "photoId": 85119203,
      "baseUrl": "https://i.oneme.ru/i?r=BUGhUou04b028GIQiF8sPj1ESMoEpchxha3Avo_VQzzdaWxqEPk3UdFqZT8kwdtrVi7FGqBwvU1WTQQJEfXzc7SX",
      "baseRawUrl": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotjvmjQrOeHcDXKj3jiosM2x3lgMsSZV0bvElZIkv3kBQ"
    }
  ]
}
GETПолучить контакт/maxapi/sync/contact/get

URL: https://wappi.pro/maxapi/sync/contact/get?recipient=123456789&phone=79915576368&profile_id={{profile_id}}

Описание метода

Получение данных конкретного контакта.

Query Params
ПараметрЗначениеОписание
recipient123456789Обязательный параметр (если не указан номер телефона в phone). Айди контакта.
phone79915576368Обязательный параметр (если не указан айди контакта в recipient). Номер телефона должен начинаться с кода страны. Для России и Казахстана это всегда 7, затем 10 цифр.
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить контакт200
{
  "status": "done",
  "timestamp": 1772305117,
  "time": "2026-02-28T21:58:37+03:00",
  "detail": "Successfully retrieved contacts",
  "task_id": "3c3fcd6114b5881197d1aa517a3b71d3",
  "command_start": "2026-02-28T21:58:37.658184469+03:00",
  "command_end": "2026-02-28T21:58:37.54297263+03:00",
  "uuid": "15396b7f-4263",
  "contact": {
    "id": 5372069,
    "accountStatus": 0,
    "names": [
      {
        "name": "Сережа",
        "firstName": "Сережа",
        "lastName": "Варгунов",
        "type": "CUSTOM"
      },
      {
        "name": "Serg",
        "firstName": "Serg",
        "lastName": "",
        "type": "ONEME"
      }
    ],
    "phone": 79816593725,
    "options": [
      "TT",
      "ONEME"
    ],
    "updateTime": 1759659756900,
    "photoId": 371346597,
    "baseUrl": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotX6aHGN_-uJI_EY4Wei407B3lgMsSZV0bvElZIkv3kBQ",
    "baseRawUrl": "https://i.oneme.ru/i?r=BTE2sh_eZW7g8kugOdIm2NotX6aHGN_-uJI_EY4Wei407B3lgMsSZV0bvElZIkv3kBQ"
  },
  "chat_id": "12312227"
}
POSTДобавить контакт/maxapi/sync/contact/add

URL: https://wappi.pro/maxapi/sync/contact/add?profile_id={{profile_id}}

Описание метода

Добавить номер в свои контакты.

Request Body

ПараметрТип данныхОбяз.Описание и пример
phonestringДаНомер телефона контакта. Допускаются различные форматы записи (со знаком +, пробелами, скобками, дефисами).Пример: "79082257537"
namestringДаИмя контакта.
Пример: "Сударушка"
last_namestringНетФамилия контакта.
Пример: "Кафе"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "phone": "79082257537",
  "name": "Сударушка-2",
  "last_name": "Кафе"
}
Responses
Добавить контакт200
{
  "status": "done",
  "timestamp": 1772439569,
  "time": "2026-03-02T11:19:29+03:00",
  "detail": "Contact added successfully",
  "task_id": "576659188d79116d3b8d77cbfbfad43a",
  "command_start": "2026-03-02T11:19:29.176807608+03:00",
  "command_end": "2026-03-02T11:19:29.223723488+03:00",
  "uuid": "15396b7f-4263",
  "contact": {
    "id": 32441031,
    "accountStatus": 0,
    "names": [
      {
        "name": "",
        "firstName": "Сударушка",
        "lastName": "Кафе",
        "type": "CUSTOM"
      },
      {
        "name": "",
        "firstName": "Svetik",
        "lastName": "",
        "type": "ONEME"
      }
    ],
    "phone": 79082256453,
    "options": null,
    "updateTime": 0
  },
  "chat_id": "17119157"
}
GETПроверить зарегистрирован ли номер/maxapi/sync/contact/check

URL: https://wappi.pro/maxapi/sync/contact/check?profile_id={{profile_id}}&phone=79602041980&user_id=5353720

Описание метода

Проверка зарегистрирован ли номер в Max.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
phone79602041980Условно обязательный параметр (обязателен, если не указан user_id. Если указаны оба приоритет у user_id). Номер телефона для проверки
user_id5353720Условно обязательный параметр (обязателен, если не указан phone. Если указаны оба приоритет у user_id). Идентификатор пользователя для проверки
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Проверить зарегистрирован ли номер200
{
  "status": "done",
  "timestamp": 1777368007,
  "time": "2026-04-28T12:20:07+03:00",
  "detail": "not found",
  "task_id": "",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-04-28T12:20:07.552775817+03:00",
  "uuid": "15396b7f-4263",
  "phone": "79118726262",
  "on_max": false,
  "chat_id": "",
  "user_id": 0
}
POSTПереименовать контакт/maxapi/sync/contact/rename

URL: https://wappi.pro/maxapi/sync/contact/rename?profile_id={{profile_id}}

Описание метода

Метод предназначен для изменения имени контакта

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringУсловноКонтакт, который нужно переименовать. Указывается идентифкатор пользователя. Пример: "5372099"
phonestringУсловноНомер телефона контакта. Допускаются различные форматы записи (со знаком +, пробелами, скобками и дефисами). Используется для поиска контакта. Пример: "79991234567"
namestringДаНовое имя контакта. Пример: "Иван"
last_namestringНетНовая фамилия контакта. Пример: "Иванов"

Необходимо передать хотя бы один из параметров: recipient или phone.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
    "phone": "79110000000",
    //"recipient": "53720000",
    "name": "Новое имя",
    "last_name": "Новая фамилия"
}
Responses
Переименовать контакт200
{
  "status": "done"
}
Работа с webhook (уведомлениями)4 метода
GETПолучить ссылку на webhook/maxapi/webhook/url/get

URL: https://wappi.pro/maxapi/webhook/url/get?profile_id={{profile_id}}

Описание метода

Получение ссылки на webhook, которая установлена для данного профиля.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить ссылку на webhook200
{
  "detail": "WebHook установлен на адрес https://webhook.site/a7cae568",
  "status": "done",
  "url": "https://webhook.site/a7cae568",
  "auth": "",
  "installed": true
}
POSTУстановить ссылку на webhook/maxapi/webhook/url/set

URL: https://wappi.pro/maxapi/webhook/url/set?profile_id={{profile_id}}&url=https://webhook.site/4c0822de-d95b-49e4-a44f-7832b15f7505&auth=34hlaksduoiyurtxm

Описание метода

Установка ссылки на webhook.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
urlhttps://webhook.site/4c0822de-d95b-49e4-a44f-7832b15f7505Обязательный параметр. URL ссылки на вебхук.
auth34hlaksduoiyurtxmНеобязательный параметр. Авторизация в вебхуке
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Установить ссылку на webhook200
{
  "status": "done",
  "timestamp": 1772440382,
  "time": "2026-03-02T11:33:02+03:00",
  "detail": "webhook url: https://webhook.site/4c0822de-d95b-49e4-a44f-7832b15f7505",
  "task_id": "eb084391-6a1c-487e-bb6f-ab4b112d3b93",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-03-02T11:33:02.388438365+03:00",
  "uuid": "15396b7f-4263"
}
POSTУдалить ссылку на webhook/maxapi/webhook/url/delete

URL: https://wappi.pro/maxapi/webhook/url/delete?profile_id={{profile_id}}

Описание метода

Удаление ссылки на webhook.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Удалить ссылку на webhook200
{
  "status": "done",
  "timestamp": 1772440477,
  "time": "2026-03-02T11:34:37+03:00",
  "detail": "webhook was deleted",
  "task_id": "2788f4b4-cc6d-43c5-951a-4f62cf363ba8",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-03-02T11:34:37.282008039+03:00",
  "uuid": "15396b7f-4263"
}
POSTНастройка типов webhook уведомлений/maxapi/webhook/types/set

URL: https://wappi.pro/maxapi/webhook/types/set?profile_id={{profile_id}}

Описание метода

Метод позволяет задать список типов webhook-уведомлений, которые будут отправляться для профиля. При повторном вызове метода список типов полностью перезаписывается.

Request Body

Тип данныхОбяз.Описание
array of stringДаМассив типов webhook-уведомлений, которые необходимо получать.

Типы webhook-уведомлений:

ТипОписание
authorization_statusСтатусы авторизации профиля (online, offline).
incoming_messageВсе входящие сообщения.
delivery_statusСтатусы доставки отправленных сообщений (pending, delivered, read).
outgoing_message_apiИсходящие сообщения, отправленные через API.
outgoing_message_phoneИсходящие сообщения, отправленные с телефона.
application_statusСтатусы авторизации приложения (online, offline).
  • Если тип webhook не указан в массиве — уведомления данного типа отправляться не будут.
  • По умолчанию для каждого нового профиля устанавливаются такие настройки: authorization_status, incoming_message, delivery_status.
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
[
  "authorization_status",
  "incoming_message",
  "delivery_status",
  "outgoing_message_phone",
  "outgoing_message_api",
  "application_status"
]
Responses
Настройка типов webhook уведомлений200
{
  "status": "done",
  "timestamp": 1772441238,
  "time": "2026-03-02T11:47:18+03:00",
  "detail": "webhook types: [authorization_status incoming_message delivery_status outgoing_message_phone outgoing_message_api application_status]",
  "task_id": "3785a1d3-fae3-477a-afc7-58b90dd2622c",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-03-02T11:47:18.635713968+03:00",
  "uuid": "15396b7f-4263"
}
Работа с группами12 методов
POSTСоздать группу/maxapi/sync/group/create

URL: https://wappi.pro/maxapi/sync/group/create?profile_id={{profile_id}}

Описание метода

Метод создаёт новую группу от имени указанного профиля и приглашает в неё участников.

Request Body

ПараметрТип данныхОбяз.Описание и пример
namestringДаНазвание создаваемой группы. Пример: "Команда продаж (user)"
participantstringУсловноНомер телефона одного участника группы. Пример: "79990000001"
participantsarray of stringУсловноМассив номеров телефонов участников группы. Пример: ["79990000002", "79990000003"]
user_idintegerУсловноЧисловой идентификатор одного пользователя MAX. Значение должно быть больше 0. Пример: 10400000
user_idsarray of integerУсловноМассив числовых идентификаторов пользователей MAX. Каждый идентификатор должен быть больше 0. Пример: [1200000, 5300000]

Условие обязательности: необходимо указать хотя бы одно из полей participant, participants, user_id или user_ids. Поля можно комбинировать в одном запросе.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "name": "Команда продаж (user)",
  "participant": "79990000001",
  "participants": [
    "79990000002",
    "79990000003"
  ],
  "user_id": 10400000,
  "user_ids": [
    1200000,
    5300000
  ]
}
Responses
Создать группу200
{
  "status": "done",
  "timestamp": 1786868494,
  "time": "2026-08-16T11:21:34+03:00",
  "detail": "Group created successfully: -77867287999858",
  "task_id": "378f8e316c4e0e1b5da30bd3593455ec",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-08-16T11:21:34.309156941+03:00",
  "uuid": "15396b7f-4263"
}
POSTПокинуть группу/maxapi/sync/group/leave

URL: https://wappi.pro/maxapi/sync/group/leave?profile_id={{profile_id}}&group_id=-71592520742258

Описание метода

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

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
group_id-71592520742258Обязательный параметр. Указывается id группы, из которой надо выйти.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Покинуть группу200
{
  "status": "done",
  "timestamp": 1771589151,
  "time": "2026-02-20T15:05:51+03:00",
  "detail": "Left group successfully",
  "task_id": "73505e1a8ac6aa24de385f6b4dda29df",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-20T15:05:51.480868752+03:00",
  "uuid": "75a40704-162c"
}
POSTДобавить участников в группу/maxapi/sync/group/participant/add

URL: https://wappi.pro/maxapi/sync/group/participant/add?profile_id={{profile_id}}

Описание метода

Метод позволяет добавить одного или нескольких участников в существующую группу.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы, в которую добавляются участники. Пример: "-77867319653746"
participantstringУсловноНомер телефона одного добавляемого участника. Пример: "79990000001"
participantsarray of stringУсловноМассив номеров телефонов добавляемых участников. Пример: ["79990000002", "79990000003"]
user_idintegerУсловноЧисловой идентификатор одного добавляемого пользователя MAX. Значение должно быть больше 0. Пример: 10400000
user_idsarray of integerУсловноМассив числовых идентификаторов добавляемых пользователей MAX. Каждый идентификатор должен быть больше 0. Пример: [1200000, 5300000]

Условие обязательности: необходимо указать хотя бы одно из полей participant, participants, user_id или user_ids. Поля можно комбинировать в одном запросе.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-77867319653746",
  "participant": "79990000001",
  "participants": [
    "79990000002",
    "79990000003"
  ],
  "user_id": 10400000,
  "user_ids": [
    1200000,
    5300000
  ]
}
Responses
Добавить участников в группу200
{
  "status": "done",
  "timestamp": 1786868719,
  "time": "2026-08-16T11:25:19+03:00",
  "detail": "Added 2 participants successfully",
  "task_id": "c84abd48ff0efeb57fee3f5fd119e727",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-08-16T11:25:19.948774321+03:00",
  "uuid": "15396b7f-4263"
}
POSTУдалить участников из группы/maxapi/sync/group/participant/remove

URL: https://wappi.pro/maxapi/sync/group/participant/remove?profile_id={{profile_id}}

Описание метода

Метод позволяет удалить участника из группы.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы, из которой удаляются участники. Пример: "-77867319653746"
participantstringУсловноНомер телефона одного удаляемого участника. Пример: "79990000001"
user_idintegerУсловноЧисловой идентификатор одного удаляемого пользователя MAX. Значение должно быть больше 0. Пример: 10400000

Условие обязательности: необходимо указать ровно одно из полей participant или user_id. Одновременная передача обоих полей не допускается. Массивы participants и user_ids в этом методе не поддерживаются.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
    "group_id": "-77867319653746",
    "participant": "79110000001"
    //"user_id": 10400000
}
Responses
Удалить участника из группы200
{
  "status": "done",
  "timestamp": 1771588542,
  "time": "2026-02-20T14:55:42+03:00",
  "detail": "Removed 1 participants successfully",
  "task_id": "c3c68c8bc846a89a29bf7d6d4609fbe0",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-20T14:55:42.442727327+03:00",
  "uuid": "75a40704-162c"
}
POSTДобавить участникам права администратора/maxapi/sync/group/admin/promote

URL: https://wappi.pro/maxapi/sync/group/admin/promote?profile_id={{profile_id}}

Описание метода

Метод позволяет назначить участника группы администратором.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы, в которой назначаются администраторы. Пример: "-77867319653746"
participantstringУсловноНомер телефона одного участника, которому назначаются права администратора. Пример: "79110000001"
participantsarray of stringУсловноМассив номеров телефонов участников, которым назначаются права администратора. Пример: ["79110000001", "79110000002"]
user_idintegerУсловноЧисловой идентификатор одного пользователя MAX, которому назначаются права администратора. Значение должно быть больше 0. Пример: 10400000
user_idsarray of integerУсловноМассив числовых идентификаторов пользователей MAX, которым назначаются права администратора. Каждый идентификатор должен быть больше 0. Пример: [10400000, 10400011]

Условие обязательности: необходимо указать хотя бы одно из полей participant, participants, user_id или user_ids. Поля можно комбинировать в одном запросе.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-77867319653746",
  "participant": "79110000001",
  "participants": [
    "79110000001",
    "79110000002"
  ],
  "user_id": 10400000,
  "user_ids": [
    10400000,
    10400011
  ]
}
Responses
Добавить участникам права администратора200
{
  "status": "done",
  "timestamp": 1786869191,
  "time": "2026-08-16T11:33:11+03:00",
  "detail": "Promoted 2 participants successfully",
  "task_id": "4d4ec6dad8b25a5d04903e01da986f6f",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-08-16T11:33:11.813184032+03:00",
  "uuid": "15396b7f-4263"
}
POSTУбрать у участников права администратора/maxapi/sync/group/admin/demote

URL: https://wappi.pro/maxapi/sync/group/admin/demote?profile_id={{profile_id}}

Описание метода

Метод позволяет снять права администратора у участника группы.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы, в которой снимаются права администратора. Пример: "-77867319653746"
participantstringУсловноНомер телефона одного участника, у которого снимаются права администратора. Пример: "79990000001"
user_idintegerУсловноЧисловой идентификатор одного пользователя MAX, у которого снимаются права администратора. Значение должно быть больше 0. Пример: 10400000

Условие обязательности: необходимо указать ровно одно из полей participant или user_id. Одновременная передача обоих полей не допускается. Массивы participants и user_ids в этом методе не поддерживаются.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
    "group_id": "-77867319653746",
    "participant": "79110000001"
    //"user_id": 10400000
}
Responses
Убрать у контакта права администратора200
{
  "status": "done",
  "timestamp": 1771160808,
  "time": "2026-02-15T16:06:48+03:00",
  "detail": "Demoted 1 participants successfully",
  "task_id": "f90b5b32056dc121c74dbe51ae08ddf1",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-15T16:06:48.546611539+03:00",
  "uuid": "75a40704-162c"
}
POSTУстановить описание группы/maxapi/sync/group/description/set

URL: https://wappi.pro/maxapi/sync/group/description/set?profile_id={{profile_id}}

Описание метода

Метод позволяет установить или изменить описание группы.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы.Пример: "-71132569253285"
descriptionstringДаНовое описание группы.Пример: "Тестовое описание группы"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-71592477554034",
  "description": "Тестовое описание группы"
}
Responses
Установить описание группы200
{
  "status": "done",
  "timestamp": 1771160468,
  "time": "2026-02-15T16:01:08+03:00",
  "detail": "Group description set successfully",
  "task_id": "41a4a3424e437482bb7c76bacecc24ed",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-15T16:01:08.803828084+03:00",
  "uuid": "75a40704-162c"
}
POSTУстановить имя группы/maxapi/sync/group/name/set

URL: https://wappi.pro/maxapi/sync/group/name/set?profile_id={{profile_id}}

Описание метода

Метод позволяет изменить название существующей группы.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы.Пример: "-71592477554034"
namestringДаНовое название группы.Пример: "Тестовое имя группы"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-71592477554034",
  "name": "Тестовое имя группы"
}
Responses
Установить имя группы200
{
  "status": "done",
  "timestamp": 1771588227,
  "time": "2026-02-20T14:50:27+03:00",
  "detail": "Group name set successfully",
  "task_id": "46dab302b56e2daf6d62df2989f84c3a",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-02-20T14:50:27.075454925+03:00",
  "uuid": "75a40704-162c"
}
POSTУстановить аватарку группы/maxapi/sync/group/avatar/set

URL: https://wappi.pro/maxapi/sync/group/avatar/set?profile_id={{profile_id}}

Описание метода

Метод позволяет установить/изменить аватар существующей группы.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-76703593231730",
  "url": "https://i.pinimg.com/originals/e6/ee/7c/e6ee7cf5538f8ffabc06bf8cc9c05f31.jpg"
}
Responses
Установить аватарку группы200
{
  "status": "done",
  "timestamp": 1784295709,
  "time": "2026-07-17T16:41:49+03:00",
  "detail": "Group avatar set successfully",
  "task_id": "4c96c6f927c6f2166d2e6b9c092c6696",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-07-17T16:41:49.04362445+03:00",
  "uuid": "15396b7f-4263"
}
POSTПередать права на группу другому участнику/maxapi/sync/group/ownership/transfer

URL: https://wappi.pro/maxapi/sync/group/ownership/transfer?profile_id={{profile_id}}

Описание метода

Метод позволяет передать права владения группой другому участнику.

Метод может быть вызван только текущим владельцем группы. Указанный participant или user_id должен быть участником группы. После успешного выполнения права владельца переходят указанному участнику

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы, права владельца которой передаются другому участнику. Пример: "-77867319653746"
participantstringУсловноНомер телефона участника, которому передаются права владельца группы. Пример: "79110000001"
user_idintegerУсловноЧисловой идентификатор пользователя MAX, которому передаются права владельца группы. Значение должно быть больше 0. Пример: 10400000

Условие обязательности: необходимо указать ровно одно из полей participant или user_id. Одновременная передача обоих полей не допускается. Массивы participants и user_ids в этом методе не поддерживаются.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-77867319653746",
  "participant": "79110000001",
  "user_id": 10400000
}
Responses
Передать права на группу другому участнику200
{
  "status": "done",
  "timestamp": 1786869586,
  "time": "2026-08-16T11:39:46+03:00",
  "detail": "Ownership transferred successfully",
  "task_id": "5e9bd0b36ae054a01ef996deb0af827c",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-08-16T11:39:46.421125354+03:00",
  "uuid": "15396b7f-4263"
}
POSTОтправить invite-ссылку группы/maxapi/sync/group/invitelink/send

URL: https://wappi.pro/maxapi/sync/group/invitelink/send?profile_id={{profile_id}}

Описание метода

Получает актуальную invite-ссылку группы MAX с устройства и отправляет её обычным сообщением получателю.

Request Body

ПараметрТип данныхОбяз.Описание и пример
group_idstringДаИдентификатор группы.Пример: "-71592477554034"
recipientstringДаПолучатель сообщения. Может быть передан как номер телефона или идентификатор чата. Допускаются различные форматы записи номера (со знаком +, пробелами, скобками, дефисами).
Пример: "79115556677"
Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "group_id": "-76668806002034",
  "recipient": "79110000000"
}
Responses
Отправить invite-ссылку группы200
{
  "status": "done",
  "timestamp": 1784104722,
  "time": "2026-07-15T11:38:42+03:00",
  "detail": "Invite link sent successfully",
  "task_id": "7fddd115c7101533ba15f0282acb7365",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-07-15T11:38:42.3374646+03:00",
  "uuid": "15396b7f-4263",
  "message_id": "116923087080534025"
}
GETПолучить invite-ссылку группы/maxapi/sync/group/invitelink/get

URL: https://wappi.pro/maxapi/sync/group/invitelink/get?profile_id={{profile_id}}&group_id=-76668806002034

Описание метода

Метод позволяет получить актуальную invite-ссылку группы MAX с устройства по group_id.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
group_id-76668806002034Обязательный параметр. Идентификатор группы.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить invite-ссылку группы200
{
  "status": "done",
  "timestamp": 1783440739,
  "time": "2026-07-07T19:12:19+03:00",
  "detail": "https://max.ru/u/f9LHodD0cOJyJJfwwJ5lpzJc2VX-gIYs0nv4jaJOpuK7hTAUx35m5DKODPU",
  "task_id": "913024f2e90ddeea26e24fed3fad956a",
  "command_start": "0001-01-01T00:00:00Z",
  "command_end": "2026-07-07T19:12:19.504337013+03:00",
  "uuid": "15396b7f-4263"
}
Работа с очередью2 метода
GETПолучить данные по задаче/maxapi/task/get

URL: https://wappi.pro/maxapi/task/get?profile_id={{profile_id}}&task_id=e90c9626-d9d6-407a-a860-a75d93f32aa2

Описание метода

Получение данных по конкретной задаче.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
task_ide90c9626-d9d6-407a-a860-a75d93f32aa2Обязательный параметр. Task_id можно получить в ответах в методах по отправке сообщений.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить данные по задаче200
{
  "status": "done",
  "task": {
    "task_id": "3785a1d3-fae3-477a-afc7-58b90dd2622c",
    "command_start": "0001-01-01T00:00:00Z",
    "uuid": "15396b7f-4263",
    "response": {
      "status": "done",
      "timestamp": 1772441238,
      "time": "2026-03-02T11:47:18+03:00",
      "detail": "webhook types: [authorization_status incoming_message delivery_status outgoing_message_phone outgoing_message_api application_status]",
      "task_id": "3785a1d3-fae3-477a-afc7-58b90dd2622c",
      "command_start": "0001-01-01T00:00:00Z",
      "command_end": "2026-03-02T08:47:18.635Z",
      "uuid": "15396b7f-4263",
      "delivery_status": "error"
    },
    "filter": {}
  }
}
GETПолучить данные по всем задачам/maxapi/tasks/get

URL: https://wappi.pro/maxapi/tasks/get?profile_id={{profile_id}}&limit=2&offset=0

Описание метода

Получение данных по всем задачам.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
limit2Необязательный параметр. Количество задач для получения.
offset0Необязательный параметр. Определяет от какого по счету элемента вывести список задач, где 0 это самая новая задача. Если не указывать, то по умолчанию установлено значение 0.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Получить данные по всем задачам200
{
  "status": "done",
  "tasks": [
    {
      "task_id": "9ff09c9a5dd7e24102f80eb860e5a429",
      "command_start": "2026-03-02T08:14:40.489Z",
      "command": "sendMessage",
      "recipient": "79602763846",
      "uuid": "15396b7f-4263",
      "body": "Привет! Как ты? Что нового?",
      "response": {
        "status": "done",
        "timestamp": 1772439280,
        "time": "2026-03-02T11:14:40+03:00",
        "detail": "Message sent successfully",
        "task_id": "9ff09c9a5dd7e24102f80eb860e5a429",
        "command_start": "2026-03-02T08:14:40.489Z",
        "command_end": "2026-03-02T08:14:40.334Z",
        "uuid": "15396b7f-4263",
        "message_id": "116158580677630247",
        "delivery_status": "delivered"
      },
      "filter": {},
      "wappi_bot_id": "18383820",
      "manager": {
        "id": "38200203",
        "name": "Светлана",
        "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
        "description": "описание пример"
      },
      "chat_id": "-71254750819698"
    },
    {
      "task_id": "d9be0aafe2ad1ae191c8d5eeb4408c77",
      "command_start": "2026-03-01T17:16:15.368Z",
      "command": "sendContact",
      "recipient": "79839487565",
      "uuid": "15396b7f-4263",
      "body": "Имя контакта",
      "phone": "79632341981",
      "response": {
        "status": "done",
        "timestamp": 1772385375,
        "time": "2026-03-01T20:16:15+03:00",
        "detail": "Contact sent successfully",
        "task_id": "d9be0aafe2ad1ae191c8d5eeb4408c77",
        "command_start": "2026-03-01T17:16:15.368Z",
        "command_end": "2026-03-01T17:16:15.216Z",
        "uuid": "15396b7f-4263",
        "message_id": "116155047953199354",
        "delivery_status": "pending"
      },
      "filter": {},
      "wappi_bot_id": "1",
      "manager": {
        "id": "38200203",
        "name": "Светлана",
        "ava_link": "https://img.freepik.com/free-photo/view-adorable-persian-domestic-cat_23-2151773882.jpg",
        "description": "описание пример"
      },
      "chat_id": "-71254750819698",
      "timeout_from": 1,
      "timeout_to": 3
    }
  ]
}
Массовая рассылка6 методов
POSTЗапустить рассылку Start/broadcast/init

URL: https://wappi.pro/broadcast/init?profile_id={{profile_id}}

Описание метода

Метод предназначен для запуска новой массовой рассылки через подключённый профиль.

В рамках одной рассылки можно отправить текстовое сообщение, изображение или файл сразу нескольким получателям. В качестве получателей могут использоваться номера телефонов, имена пользователей (username), идентификаторы пользователей или идентификаторы чатов, если это поддерживается используемой платформой.

Поддерживаются случайные задержки между отправками сообщений, отложенный запуск и выполнение рассылки по расписанию.

После успешного запуска создаётся задача рассылки и возвращается информация о созданной кампании, включая её идентификатор, количество получателей и текущий статус.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса formdata
mass_text: Текст сообщения - отложен
mass_phones: 79000000000
79000000000
79000000000
mass_image: file
mass_timeout_from: 5
mass_timeout_to: 8
Responses
Запустить рассылку Start200
{
    "status": "done",
    "timestamp": 1781187491,
    "time": "2026-06-11T17:18:11+03:00",
    "detail": "Рассылка запущена",
    "posting": {
        "active": 3,
        "messages_count": 3,
        "profile_id": 0000000,
        "profile_uuid": "",
        "platform": "tg",
        "user_id": 00000,
        "mass_posting_id": "b51cc198-a0db-4c",
        "profile_name": "testTG",
        "created_at": "11.06.2026 17:18:10",
        "have_consumer": true,
        "send_time": "2026-06-11T17:18:10.894572499+03:00",
        "is_delayedStart": false,
        "is_onDiary": false,
        "is_paused": false
    }
}
GETПриостановить рассылку Pause/broadcast/pause

URL: https://wappi.pro/broadcast/pause?profile_id={{profile_id}}&mass_posting_id=e1b35b69-b35e-4d

Описание метода

Метод предназначен для приостановки активной массовой рассылки.

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

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
mass_posting_ide1b35b69-b35e-4dОбязательный параметр. ID рассылки, которую необходимо приостановить. Значение возвращается при создании рассылки или доступно в адресной строке в UI (значение ?id=)
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Приостановить рассылку Pause200
{
  "detail": "Mass posting paused",
  "status": "done"
}
GETВозобновить рассылку Resume/broadcast/start

URL: https://wappi.pro/broadcast/start?profile_id={{profile_id}}&mass_posting_id=e1b35b69-b35e-4d

Описание метода

Метод предназначен для возобновления ранее приостановленной массовой рассылки.

После выполнения запроса рассылка продолжит отправку сообщений с того места, на котором была остановлена. Уже отправленные сообщения повторно не отправляются.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
mass_posting_ide1b35b69-b35e-4dОбязательный параметр. ID рассылки, которую необходимо возобновить. Значение возвращается при создании рассылки или доступно в адресной строке в UI (значение ?id=)
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Возобновить рассылку Resume200
{
  "detail": "Mass posting started",
  "status": "done"
}
GETЗакрыть рассылку Cancel/broadcast/cancel

URL: https://wappi.pro/broadcast/cancel?profile_id={{profile_id}}&mass_posting_id=e1b35b69-b35e-4d

Описание метода

Закрыть рассылку.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
mass_posting_ide1b35b69-b35e-4dОбязательный параметр. ID рассылки, которую необходимо отменить. Значение возвращается при создании рассылки или доступно в адресной строке в UI (значение ?id=)
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Закрыть рассылку Cancel200
{
  "detail": "Mass posting canceled",
  "status": "done"
}
GETСписок всех рассылок/broadcast/history

URL: https://wappi.pro/broadcast/history?profile_id={{profile_id}}&offset=0&limit=3

Описание метода

Метод предназначен для получения истории массовых рассылок, созданных в указанном профиле.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
offset0Необязательный параметр. От какого по счету элемента вывести список сообщений, где 0 это самое новое сообщение. Если не указывать, то по умолчанию установлено значение 0.
limit3Необязательный параметр. Количество сообщений для получения. Если не указывать, то по умолчанию установлено значение 200.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Список всех рассылок200
{
  "all_history_count": 10,
  "all_started_count": 0,
  "consumers": null,
  "mass_posting_history": [
    {
      "profile_uuid": "48affe30-713e",
      "profile_name": "testovi4okTG",
      "platform": "tg",
      "mass_posting_id": "e1b35b69-b35e-4d",
      "done": 0,
      "all": 1,
      "date": "2026-06-11T17:32:47.300736+03:00"
    },
    {
      "profile_uuid": "48affe30-713e",
      "profile_name": "testovi4okTG",
      "platform": "tg",
      "mass_posting_id": "30007edb-4000-4a",
      "done": 0,
      "all": 3,
      "date": "2026-06-11T17:31:38.395868+03:00"
    },
    {
      "profile_uuid": "48affe30-713e",
      "profile_name": "testovi4okTG",
      "platform": "tg",
      "mass_posting_id": "198fad6f-a064-4f",
      "done": 3,
      "all": 3,
      "date": "2026-06-11T17:31:29.7157+03:00"
    }
  ],
  "mass_posting_started": [],
  "status": "done"
}
GETРезультат рассылки/broadcast/messages

URL: https://wappi.pro/broadcast/messages?profile_id={{profile_id}}&mass_posting_id=bf0718c6-2610-44&offset=0&limit=100

Описание метода

Метод предназначен для получения подробной информации о конкретной массовой рассылке.

Query Params
ПараметрЗначениеОписание
profile_id{{profile_id}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
mass_posting_idbf0718c6-2610-44Обязательный параметр. ID рассылки, результаты которой необходимо получить. Значение возвращается при создании рассылки или доступно в адресной строке в UI (значение ?id=)
offset0Необязательный параметр. От какого по счету элемента вывести список сообщений, где 0 это самое новое сообщение. Если не указывать, то по умолчанию установлено значение 0.
limit100Необязательный параметр. Количество сообщений для получения. Если не указывать, то по умолчанию установлено значение 400.
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Результат рассылки200
{
  "status": "done",
  "detail": [
    {
      "delivered": "delivered",
      "recipient": "79000000000",
      "message": "Текст сообщения",
      "caption": "",
      "created_at": "2026-06-11T14:31:47.056Z",
      "task_name": "sendMessage",
      "profile": {
        "name": "testTG",
        "uuid": "48affe30-713e",
        "platform": "tg"
      },
      "task_id": "c84541c8-681e-43ae-848f-39b4b6ad07d5"
    },
    {
      "delivered": "delivered",
      "recipient": "79000000000",
      "message": "Текст сообщения",
      "caption": "",
      "created_at": "2026-06-11T14:31:38.02Z",
      "task_name": "sendMessage",
      "profile": {
        "name": "testTG",
        "uuid": "48affe30-713e",
        "platform": "tg"
      },
      "task_id": "ba82af8c-51d0-41e0-9d58-90037ed3a8c0"
    },
    {
      "delivered": "delivered",
      "recipient": "79000000000",
      "message": "Текст сообщения",
      "caption": "",
      "created_at": "2026-06-11T14:31:29.02Z",
      "task_name": "sendMessage",
      "profile": {
        "name": "testTG",
        "uuid": "48affe30-713e",
        "platform": "tg"
      },
      "task_id": "62eae084-d9d0-44a3-9c00-c5ca0b076fcf"
    }
  ],
  "all_messages_count": 3
}
Каскады6 методов
POSTОтправить сообщение каскадом/csender/cascade/send

URL: https://wappi.pro/csender/cascade/send

Описание метода

Метод предназначен для отправки сообщения через ранее созданный каскад.

Сообщение будет отправлено получателю с использованием последовательности профилей и платформ, указанных в настройках каскада. Если доставка не будет выполнена на одном из этапов, система автоматически перейдёт к следующему каналу каскада.

Request Body

ПараметрТип данныхОбяз.Описание и пример
recipientstringДаНомер телефона получателя, на который будет выполнена отправка через каскад. Допускаются различные форматы записи номера телефона (со знаком +, пробелами, скобками и дефисами). Примеры: "79115556677", "+7 (911) 555-66-77"
bodystringУсловноТекст сообщения. Поддерживаются переносы строк и emoji. Пример: "Тестовое сообщение"
captionstringНетПодпись к вложению. Используется при отправке медиафайла. Пример: "Описание файла"
cascade_idstringДаИдентификатор каскада, через который необходимо выполнить отправку сообщения. Пример: "94b1f524059b29e514ef"
file_namestringНетИмя файла, которое будет отображаться получателю. Используется при отправке вложения по ссылке. Примеры: "image.jpg", "document.pdf"
urlstringУсловноПрямая ссылка на файл, который необходимо отправить получателю. Пример: "https://example.com/file.jpg"

Условие обязательности: Обязателен как минимум один из атрибутов

Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "recipient": "79000000000",
  "body": "Test",
  "caption": "Подпись",
  "cascade_id": "f65e1ad54ea8a97c3271",
  "file_name": "",
  "url": "https://i.pinimg.com/originals/00/cc/0f/00cc0f951851943cef0df2ab42776cee.jpg?nii=t"
}
Responses
Отправить сообщение каскадом200
{
  "response": {
    "status": "done",
    "timestamp": 1781255242,
    "time": "2026-06-12T12:07:22+03:00",
    "detail": "Message sent to queue",
    "task_id": "6c8f2f47a4630bb18b4aeab2c1b4f125",
    "command_start": "0001-01-01T00:00:00Z",
    "command_end": "0001-01-01T00:00:00Z",
    "uuid": ""
  },
  "status": "ok"
}
POSTСоздать каскад/csender/cascade/create

URL: https://wappi.pro/csender/cascade/create

Описание метода

Метод предназначен для создания каскада отправки сообщений.

Request Body

ПараметрТип данныхОбяз.Описание и пример
namestringДаНазвание каскада. Пример: "Cascade Test"
descriptionstringНетОписание каскада. Пример: "Тестовое описание каскада"
orderarrayДаМассив этапов каскада в порядке выполнения.
order.idintegerДаПорядковый номер этапа каскада. Пример: 1
order.profile_uuidstringДаИдентификатор профиля, через который будет выполняться отправка на данном этапе.
order.platformstringДаПлатформа профиля. Возможные значения зависят от используемых каналов. Примеры: "tg", "wz", "max"
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "name": "CascadeTestNew",
  "description": "тестовое описание каскада",
  "order": [
    {
      "id": 1,
      "profile_uuid": "15396b7f-4263",
      "platform": "max"
    },
    {
      "id": 2,
      "profile_uuid": "48affe30-713e",
      "platform": "tg"
    },
    {
      "id": 3,
      "profile_uuid": "d64e106a-65d6",
      "platform": "wz"
    }
  ]
}
Responses
Создать каскад200
{
  "cascade": {
    "cascade_id": "aea42c1f8c4632b8b097",
    "name": "CascadeTestNew",
    "description": "тестовое описание каскада",
    "order": [
      {
        "id": 0,
        "profile_uuid": "15396b7f-4263",
        "platform": "max"
      },
      {
        "id": 1,
        "profile_uuid": "48affe30-713e",
        "platform": "tg"
      }
    ],
    "crm_id": "",
    "crm_type": ""
  },
  "status": "created"
}
POSTРедактировать каскад/csender/cascade/update

URL: https://wappi.pro/csender/cascade/update

Описание метода

Метод предназначен для изменения параметров существующего каскада отправки сообщений.

С помощью метода можно изменить название каскада, описание, а также порядок и состав этапов отправки. После обновления каскад будет использовать новую последовательность профилей и платформ для доставки сообщений.

Важно. При редактировании каскада параметр order полностью заменяет текущий список этапов. Необходимо передавать полный актуальный список каналов в требуемом порядке. Этапы, отсутствующие в новом массиве order, будут удалены из каскада.

Request Body

ПараметрТип данныхОбяз.Описание и пример
cascade_idstringДаИдентификатор каскада. Пример: "6736ebe208b0fd04c84f"
namestringНетНазвание каскада. Пример: "NewCascade"
descriptionstringНетОписание каскада.
orderarrayНетСписок этапов каскада в порядке выполнения.
order.idintegerНетПорядковый номер этапа каскада. Пример: 1
order.profile_uuidstringНетИдентификатор профиля, через который будет выполняться отправка на данном этапе.
order.platformstringДаПлатформа профиля. Примеры: "tg", "wz", "max"
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw
{
  "cascade_id": "d6228696b6c2f36bfd30",
  "name": "NewCascade",
  "description": "",
  "order": [
    {
      "id": 1,
      "profile_uuid": "87529b21-2ace",
      "platform": "tg"
    },
    {
      "id": 2,
      "profile_uuid": "d64e106a-65d6",
      "platform": "wz"
    },
    {
      "id": 3,
      "profile_uuid": "d64e106a-65d6",
      "platform": "max"
    }
  ]
}
Responses
Редактировать каскад200
{
  "cascade": {
    "cascade_id": "d6228696b6c2f36bfd30",
    "name": "NewCascade",
    "description": "",
    "order": [
      {
        "id": 1,
        "profile_uuid": "87529b21-2ace",
        "platform": "tg"
      },
      {
        "id": 2,
        "profile_uuid": "d64e106a-65d6",
        "platform": "wz"
      },
      {
        "id": 3,
        "profile_uuid": "d64e106a-65d6",
        "platform": "max"
      }
    ],
    "crm_id": "",
    "crm_type": ""
  },
  "status": "updated"
}
POSTУдалить каскад/csender/cascade/delete

URL: https://wappi.pro/csender/cascade/delete?cascade_id=aea42c1f8c4632b8b097

Описание метода

Метод предназначен для удаления существующего каскада отправки сообщений.

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

Query Params
ПараметрЗначениеОписание
cascade_idaea42c1f8c4632b8b097Обязательный параметр. Идентификатор каскада, который необходимо удалить. Пример: "6736ebe208b0fd04c84f"
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Responses
Удалить каскад200
{
  "status": "deleted"
}
GETПолучить данные каскада/csender/cascade/get

URL: https://wappi.pro/csender/cascade/get?cascade_id=f65e1ad54ea8a97c3271

Описание метода

Метод предназначен для получения подробной информации о ранее созданном каскаде отправки сообщений.

Query Params
ПараметрЗначениеОписание
cascade_idf65e1ad54ea8a97c3271Обязательный параметр. Идентификатор каскада, данные которого необходимо получить
Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw

Тело запроса не передается.

Responses
Получить данные каскада200
{
  "cascade": {
    "cascade_id": "f65e1ad54ea8a97c3271",
    "name": "Название каскада тестовый",
    "description": "",
    "order": [
      {
        "id": 0,
        "profile_uuid": "48affe30-713e",
        "platform": "tg"
      },
      {
        "id": 1,
        "profile_uuid": "15396b7f-4263",
        "platform": "max"
      }
    ],
    "crm_id": "",
    "crm_type": ""
  },
  "status": "ok"
}
GETПолучить данные всех каскадов/csender/cascades/get

URL: https://wappi.pro/csender/cascades/get

Описание метода

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

Headers
КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.
Тело запроса raw

Тело запроса не передается.

Responses
Получить данные всех каскадов200
{
  "cascades": [
    {
      "cascade_id": "f65e1ad54ea8a97c3271",
      "name": "Название каскада тестовый",
      "description": "",
      "order": [
        {
          "id": 0,
          "profile_uuid": "48affe30-713e",
          "platform": "tg"
        },
        {
          "id": 1,
          "profile_uuid": "15396b7f-4263",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "d6228696b6c2f36bfd30",
      "name": "NewCascade",
      "description": "",
      "order": [
        {
          "id": 1,
          "profile_uuid": "48affe30-713e",
          "platform": "tg"
        },
        {
          "id": 2,
          "profile_uuid": "df810086-b6f5",
          "platform": "max"
        },
        {
          "id": 3,
          "profile_uuid": "d64e106a-65d6",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "6736ebe208b0fd04c84f",
      "name": "NewCascade",
      "description": "",
      "order": [
        {
          "id": 1,
          "profile_uuid": "",
          "platform": "tg"
        },
        {
          "id": 2,
          "profile_uuid": "d64e106a-65d6",
          "platform": "wz"
        },
        {
          "id": 3,
          "profile_uuid": "d64e106a-65d6",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "77520bc34d98aca07920",
      "name": "Cascade Test1",
      "description": "тестовое описание каскада",
      "order": [
        {
          "id": 0,
          "profile_uuid": "15396b7f-4263",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "2449646d6568e27c4378",
      "name": "Cascade Test1",
      "description": "тестовое описание каскада",
      "order": [
        {
          "id": 0,
          "profile_uuid": "15396b7f-4263",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "436efeed775b21ed15d4",
      "name": "Cascade Test1",
      "description": "тестовое описание каскада",
      "order": [
        {
          "id": 0,
          "profile_uuid": "",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    },
    {
      "cascade_id": "aea42c1f8c4632b8b097",
      "name": "NewCascade",
      "description": "",
      "order": [
        {
          "id": 2,
          "profile_uuid": "15396b7f-4263",
          "platform": "max"
        }
      ],
      "crm_id": "",
      "crm_type": ""
    }
  ],
  "status": "ok"
}

Тестирование методов

Как протестировать методы MAX API

01Получите токен

Откройте личный кабинет и скопируйте API-токен из профиля MAX.

02Передайте profile_id

Добавляйте profile_id в query и Authorization в headers каждого запроса.

03Проверьте метод

Выберите endpoint слева, скопируйте CURL или откройте Postman collection.

04Подключите webhook

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

Создать профиль

Работа с профилем

POST
Подробная информацияURL, описание, параметры, headers, тело запроса, responses и CURLСвернутьРазвернуть
POSThttps://wappi.pro/maxapi/profile/add?name=новый3&webhook_url=https://wappi.pro

Описание метода

Метод предназначен для создания нового профиля.

Вы передаете имя нового профиля, а его profile_id автоматически генерируется системой и возвращается в ответе.

Query Params

ПараметрЗначениеОписание
nameновый3Обязательный параметр. Имя нового профиля.
webhook_urlhttps://wappi.proНеобязательный параметр. Установка URL ссылки на вебхук.

Headers

КлючЗначениеОписание
Authorization{{Token}}Обязательный параметр. Можно получить в личном кабинете на странице конкретного профиля.

Responses

Создать профиль200
{
  "profile_id": "21f018f2-647a",
  "status": "done",
  "time": "2026-03-06T13:03:50+03:00",
  "timestamp": 1772791430
}

Пример CURL запроса

curl --request POST 'https://wappi.pro/maxapi/profile/add?name=новый3&webhook_url=https://wappi.pro' \
    --header 'Authorization: {{Token}}'

Тест запроса

POSThttps://wappi.pro/maxapi/profile/add?name=%D0%BD%D0%BE%D0%B2%D1%8B%D0%B93&webhook_url=https%3A%2F%2Fwappi.pro
Query Params

Введите token, чтобы отправить тестовый запрос на https://wappi.pro.

Типы уведомлений Webhook

01Укажите адрес

Webhook - это URL для событий. Указать его можно в личном кабинете или через API.

02Выберите события

В личном кабинете или через API выберите типы: входящие, доставки, статусы профиля.

03Примите запрос

Ваш сервер должен принять POST-запрос с JSON и быстро вернуть успешный HTTP-ответ.

04Проверьте тестом

Для проверки вставьте временный URL из webhook.site или похожего сервиса.

Webhook на статус отправленного сообщения

Есть несколько статусов отправленных сообщений - pending, delivered, read, undelivered, temporary ban, error.


{
  "messages": {
    "id": "114986604267657812",
    "profile_id": "d6f3286b-e584",
    "wh_type": "delivery_status",
    "timestamp": "2025-08-07T11:45:41.554596021+03:00",
    "time": 1754556339533,
    "from": "79602041981",
    "to": "79115576368",
    "chat_id": "1820755",
    "status": "delivered",
    "task_id": "c47ab086-8a2a-49a2-9904-6dd39bcf4886"
  }
}
                            
Свернуть

Webhook на статус профиля

Есть несколько статусов профиля - online, offline, ACCOUNT_SPAM_RESTRICTED, CHECK_PHONE_FLOODWAIT


{
  "messages": [
    {
      "wh_type": "authorization_status",
      "profile_id": "71ad40e9-b023",
      "status": "offline",
      "reason": "logout from api",
      "phone": "79502041990",
      "timestamp": "2025-07-13T17:00:02.57417156+03:00",
      "time": 1699884002
    }
  ]
}
                            
Свернуть

Webhook на статус приложения


{
  "messages": [
    {
      "wh_type": "application_status",
      "profile_id": "81ad40e9-b023",
      "status": "online",
      "phone": "79991112233",
      "timestamp": "2025-08-01T22:04:44.198883039+03:00",
      "time": 1682967884
    }
  ]
}
                            
Свернуть

Webhook на входящее сообщение


{
  "messages": [
    {
      "id": "114992218890840885",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-08T11:33:31+03:00",
      "time": 1754642011884,
      "body": "Текстовое сообщение",
      "type": "text",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на входящее изображение

Все изображения отдаются ссылками на скачивание, у которых есть время жизни.


{
  "messages": [
    {
      "id": "114986632090512620",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-07T11:52:44+03:00",
      "time": 1754556764076,
      "body": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/46ff3965-f13d-40be-b71a-3725681ada2c.webp?X-Am084",
      "type": "image",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "mimetype": "image/webp",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e58446ff3965-f13d-40be-b71a-3725681ada2c.webp?X-Amz687e90f18eedc66acb69e099e245523084",
      "file_link_expire": 1754729564,
      "media_info": {
        "width": 1440,
        "height": 1920,
        "size": 0,
        "duration": 0,
        "is_round": false
      },
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на входящее видео

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


{
  "messages": [
    {
      "id": "114986807251847681",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-07T12:37:16+03:00",
      "time": 1754559436826,
      "body": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/8809545796204.mp4?X-Aa893ee",
      "type": "video",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "mimetype": "video/mp4",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/8809545796204.mp4?X-d0a893ee",
      "file_link_expire": 1754732238,
      "media_info": {
        "width": 720,
        "height": 1280,
        "size": 0,
        "duration": 0,
        "is_round": false
      },
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на входящий документ или файл

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


{
  "messages": [
    {
      "id": "114986635801860743",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-07T11:53:40+03:00",
      "time": 1754556820707,
      "body": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/82.txt?X-A112ab",
      "type": "document",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "file_name": "текст.txt",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/82.txt?X-Am112ab",
      "file_link_expire": 1754729620,
      "media_info": {
        "width": 0,
        "height": 0,
        "size": 0,
        "duration": 0,
        "is_round": false
      },
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на входящее голосовое сообщение


  {
    "messages": [
      {
        "id": "5908",
        "profile_id": "51a8107a-5442",
        "wh_type": "incoming_message",
        "timestamp": "2025-03-17T15:21:59+03:00",
        "time": 1742214119,
        "body": "JVBERi0xLjcNCiXi48/TDQo1IDAgb2JqD",
        "type": "ptt",
        "from": "60227586",
        "to": "5279188641",
        "senderName": "Sinn",
        "chatId": "60227586",
        "caption": "",
        "from_where": "phone",
        "mimetype": "audio/ogg",
        "contact_name": "Sinn",
        "contact_phone": "",
        "contact_username": "sinay",
        "username": "sinay",
        "is_forwarded": false,
        "isReply": false,
        "is_edited": false,
        "stanza_id": "",
        "is_me": false,
        "chat_type": "user",
        "thumbnail": "https://fs.wappi.pro/t_6056.jpg",
        "picture": "",
        "wappi_bot_id": "",
        "is_deleted": false,
        "is_bot": false,
        "length_seconds": 1,
        "file_link": "https://wapi-u.storage.yandexcloud.net/51a",
        "file_link_expire": 1742473320
      }
    ]
  }
                            
Свернуть

Webhook на входящее аудио или голосовое сообщение

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


{
  "messages": [
    {
      "id": "114986632723455254",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-07T11:52:53+03:00",
      "time": 1754556773734,
      "body": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/8809510275692.mp3?X-A5f27b8",
      "type": "audio",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "mimetype": "audio/mpeg",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "file_link": "https://wapi-uploads7d.storage.yandexcloud.net/d6f3286b-e584/8809510275692.mp3?X-Amz5f27b8",
      "file_link_expire": 1754729573,
      "media_info": {
        "width": 0,
        "height": 0,
        "size": 0,
        "duration": 3530,
        "is_round": false
      },
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на входящую геолокацию


{
    "messages": [
      {
        "id": "114986633608132594",
        "profile_id": "d6f3286b-e584",
        "wh_type": "incoming_message",
        "timestamp": "2025-08-07T11:53:07+03:00",
        "time": 1754556787233,
        "body": "Location { Name: , Latitude: 64.596070, Longitude: 39.847370, DegreesLatitude: 0.000000, DegreesLongitude: 0.000000, Description: , JPEGThumbnail:  }",
        "type": "location",
        "from": "79115576368",
        "to": "79602041981",
        "senderName": "Max",
        "senderLastName": "RAD",
        "chatId": "1820755",
        "caption": null,
        "from_where": "phone",
        "location": {
          "latitude": 64.59607,
          "longitude": 39.84737,
          "description": "",
          "degreesLatitude": 0,
          "degreesLongitude": 0,
          "name": ""
        },
        "contact_name": "Макс Моряк",
        "contact_last_name": "",
        "contact_max_name": "Max",
        "contact_max_last_name": "RAD",
        "contact_phone": "79115576368",
        "contact_username": "",
        "phone": "79115576368",
        "is_forwarded": false,
        "isReply": false,
        "is_edited": false,
        "stanza_id": "",
        "is_me": false,
        "isGif": false,
        "thumbnail": "",
        "picture": "",
        "wappi_bot_id": "",
        "is_deleted": false,
        "is_bot": false,
        "media_info": {
          "width": 0,
          "height": 0,
          "size": 0,
          "duration": 0,
          "is_round": false
        },
        "is_blacklist": false
      }
    ]
  }
                            
Свернуть

Webhook на входящий контакт


{
  "messages": [
    {
      "id": "114986634530931463",
      "profile_id": "d6f3286b-e584",
      "wh_type": "incoming_message",
      "timestamp": "2025-08-07T11:53:21+03:00",
      "time": 1754556801314,
      "body": "Contact { DisplayName: Владислав Васильевич, Phone: +79212410555, Vcard: BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:ez-vcard 0.10.3\r\nTEL;TYPE=CELL,VOICE,pref:+79212410555\r\nFN:Владислав Васильевич\r\nEND:VCARD\r\n }",
      "type": "vcard",
      "from": "79115576368",
      "to": "79602041981",
      "senderName": "Max",
      "senderLastName": "RAD",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "contact": {
        "display_name": "Владислав Васильевич",
        "phone": "+79212410555",
        "vcard": "BEGIN:VCARD\r\nVERSION:3.0\r\nPRODID:ez-vcard 0.10.3\r\nTEL;TYPE=CELL,VOICE,pref:+79212410555\r\nFN:Владислав Васильевич\r\nEND:VCARD\r\n"
      },
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79115576368",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": false,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "media_info": {
        "width": 0,
        "height": 0,
        "size": 0,
        "duration": 0,
        "is_round": false
      },
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на исходящее сообщение API


{
  "messages": [
    {
      "id": "114986892458668556",
      "profile_id": "d6f3286b-e584",
      "wh_type": "outgoing_message_api",
      "timestamp": "2025-08-07T12:58:56+03:00",
      "time": 1754560736979,
      "body": "Текстовое сообщение",
      "type": "text",
      "from": "79602041981",
      "to": "79115576368",
      "senderName": "Mi",
      "senderLastName": "Mi",
      "chatId": "1820755",
      "caption": null,
      "from_where": "api",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79602041981",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": true,
      "task_id": "2c7c54b6-f923-4fa8-b035-b6ad9a881aab",
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Webhook на исходящее сообщение с телефона


{
  "messages": [
    {
      "id": "114992166609179805",
      "profile_id": "d6f3286b-e584",
      "wh_type": "outgoing_message_phone",
      "timestamp": "2025-08-08T11:20:14+03:00",
      "time": 1754641214129,
      "body": "Текстовое сообщение с телефона",
      "type": "text",
      "from": "79602041981",
      "to": "79115576368",
      "senderName": "Mi",
      "senderLastName": "",
      "chatId": "1820755",
      "caption": null,
      "from_where": "phone",
      "contact_name": "Макс Моряк",
      "contact_last_name": "",
      "contact_max_name": "Max",
      "contact_max_last_name": "RAD",
      "contact_phone": "79115576368",
      "contact_username": "",
      "phone": "79602041981",
      "is_forwarded": false,
      "isReply": false,
      "is_edited": false,
      "stanza_id": "",
      "is_me": true,
      "isGif": false,
      "thumbnail": "",
      "picture": "",
      "wappi_bot_id": "",
      "is_deleted": false,
      "is_bot": false,
      "is_blacklist": false
    }
  ]
}
                            
Свернуть

Частые вопросы

Можно ли получить бан за использование сервиса?

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

Не нашли ответ на свой вопрос?

Наша поддержка всегда готова помочь

Telegram

Тарифы MAX API

Бесплатный пробный период 5 дней

  • 1 месяц
  • 3 месяца-5%
  • 6 месяцев-10%
  • 12 месяцев-20%

MAXБазовый

700 ₽
650 ₽700 ₽
630 ₽700 ₽
550 ₽700 ₽

за 1 профиль в месяц

Профиль это один подключенный аккаунт мессенджера. В рамках одного профиля можно менять номера.
  • Безлимит на сообщения
  • API:
    • MAX API
  • Сервисы:
    • Агрегатор мессенджеров
    • Чат-боты
    • Рассылка сообщений
    • ИИ-ассистент
    • Виджет на сайт
  • Без готовых интеграций

Скидки при оплате 10+ профилей

Начать бесплатно

MAXПолный

1690 ₽
1600 ₽1690 ₽
1500 ₽1690 ₽
1350 ₽1690 ₽

за 1 профиль в месяц

Профиль это один подключенный аккаунт мессенджера. В рамках одного профиля можно менять номера.
  • Безлимит на сообщения
  • API:
    • MAX API
  • Сервисы:
    • Агрегатор мессенджеров
    • Чат-боты
    • Рассылка сообщений
    • ИИ-ассистент
    • Виджет на сайт
  • Готовые интеграции:
    • Битрикс24
    • amoCRM
    • МойСклад
    • RetailCRM

Скидки при оплате 10+ профилей

Начать бесплатно

Что еще предлагаем?

Становитесь техническим партнером и внедряйте мессенджеры в свою CRM или сервис с эксклюзивными условиями:

  • Скидки от объема
  • Подневная тарификация
  • Постоплата
  • Индивидуальные условия

Подробнее здесь

Стать партнером