Путь — /waInstance{id}/{метод}/{token} или /v1/instances/{id}/{метод} с Authorization: Bearer. Каналы: M — MAX, T — Telegram, W — WhatsApp, @ — почта. Метод, которого канал не умеет, отвечает 501.
Канал
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| getStateInstance | GET | состояние канала | M T W @ |
| getCapabilities | GET | что умеет канал | M T W @ |
| getSettings, setSettings | GET, POST | настройки и вебхук | M T W @ |
| reboot | GET | переподключить к мессенджеру | M T W @ |
Что умеет канал — Возможности каналов.
Отправка
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| sendMessage | POST | текст | M T W @ |
| sendFileByUpload | POST multipart | файл в запросе | M T W @ |
| sendFileByUrl | POST | файл по ссылке | M T W @ |
| uploadFile | POST, тело — файл | загрузить файл в хранилище | M T W @ |
| sendLocation, sendContact, sendPoll | POST | геопозиция, контакт, опрос | T W |
| forwardMessages | POST | переслать сообщения | T W @ |
sendButtons, sendInteractiveButtons |
POST | кнопки — не поддерживается | — |
Действия с сообщениями и чатами
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| editMessage | POST | исправить своё | M T W |
| deleteMessage | POST | удалить у всех или у себя | M T W |
| sendReaction | POST | реакция | M T W |
| getAllowedReactions | POST | какие реакции можно | T W |
| sendTyping | POST | «печатает» | M T W |
| readChat | POST | отметить прочитанным | M T W @ |
| archiveChat и unarchiveChat | POST | архив | W |
| pinChat и unpinChat, pinMessage и unpinMessage | POST | закрепы | W |
Уведомления
| Метод | HTTP | Что |
|---|---|---|
| receiveNotification | GET | следующее уведомление из очереди |
| deleteNotification | DELETE …/{receiptId} |
подтвердить уведомление |
| getWebhooksCount, clearWebhooksQueue | GET | сколько в очереди; очистить |
| getDeadNotifications, requeueDeadNotifications | GET, POST | отравленные; вернуть в очередь |
| subscriptions | GET, POST, DELETE …/{id} |
подписки на копию ленты |
| Очередь исходящих | GET | для совместимости: исходящей очереди нет |
История, файлы, контакты
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| getChatHistory | POST | история чата | M T W @ |
| getMessage | POST | одно сообщение | M T W @ |
| lastIncomingMessages и lastOutgoingMessages | GET | журнал за N минут | M T W @ |
| downloadFile | POST | ссылка на файл сообщения | M T W @ |
| getChats, getContacts | GET | чаты и контакты | M T W @ |
| getContactInfo | POST | профиль собеседника | M T W @ |
| getAvatar | POST | фото профиля или группы | M T W |
| checkAccount | POST | есть ли аккаунт на номере | M T W |
Группы
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| createGroup | POST | создать | M T W |
| getGroupData | POST | данные и участники | M T W |
| updateGroupName, updateGroupSettings | POST | название, права участников | M T W |
| setGroupPicture | POST multipart | фото (JPEG) | M T W |
| addGroupParticipant, removeGroupParticipant | POST | участники | M T W |
| setGroupAdmin, removeAdmin | POST | администраторы | M T W |
| leaveGroup | POST | выйти | M T W |
| deleteGroup | POST | убрать всех и выйти | W |
Каналы и сообщества
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| searchChats | POST | поиск каналов, групп, людей | M T |
| getChatPreview | POST | превью по ссылке или адресу | M T |
| joinChat | POST | вступить | M T |
| getJoinLimits | POST | темп и пределы вступлений | M T |
| getSimilarChannels | POST | похожие каналы | M T |
| getJoinRequests, answerJoinRequest | POST | заявки в свой чат | M T |
| createInviteLink | POST | дополнительная ссылка | T |
| revokeInviteLink | POST | сбросить основную ссылку | M T |
| getStories, sendStory, editStory, deleteStory, pinStory, getStoryViews | POST | истории | T |
Звонки
| Метод | HTTP | Что | Каналы |
|---|---|---|---|
| answerCall, rejectCall | POST | ответить, отклонить | M W, если call_audio |
| makeCall | POST | позвонить | M W, если call_audio |
| playAudio | POST | сказать файлом | M W, если call_audio |
| hangUpCall | POST | положить трубку | M W, если call_audio |
| getCall и getActiveCalls | POST | звонок; идущие разговоры | M W, если call_audio |
| WebSocket callAudio | WSS | живой звук | M W, если call_audio |
Почта
| Метод | Что |
|---|---|
| connectMailbox, disconnectMailbox, getMailboxInfo | подключить, отключить, сведения о ящике |
| getFolders, createFolder, renameFolder, deleteFolder | папки |
| getMessages, searchMessages | списки и поиск |
| getEmail, getEmailRaw, getThread | письмо целиком, .eml, цепочка |
| markMessages, setMessageFlags | флаги |
| moveMessages, copyMessages, deleteMessages | перенос и удаление |
| sendEmail, replyEmail, forwardEmail | отправка, ответ, пересылка |
| saveDraft, sendDraft | черновики |
Все — POST с телом JSON. Подробно — Почта через API.
Ссылки без токена
| Адрес | Что |
|---|---|
GET /media/{idInstance}/{chatId}/{idMessage}/{n}/{подпись} |
файл сообщения, аватар, история |
GET /upload/{idInstance}/{id}/{подпись}/{имя} |
файл из uploadFile |
GET /calls/{idInstance}/{callId}/{подпись}.wav |
запись звонка |