Отвечает, что умеет канал: файлы, реакции, правку, удаление у всех, группы, звонки, длину текста. Спросите канал перед тем, как показывать функцию в своём интерфейсе: метод, которого канал не умеет, отвечает 501 not_supported.
| Запрос | GET /waInstance{idInstance}/getCapabilities/{apiTokenInstance} |
| Тело | нет |
| Каналы | MAX, Telegram, WhatsApp, почта |
Пример запроса
Узнать возможности канала:
curl
curl "$GRATIO_URL/waInstance$GRATIO_ID/getCapabilities/$GRATIO_TOKEN"
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/getCapabilities/{TOKEN}"
response = requests.get(url, timeout=60)
print(response.status_code, response.json())
Node.js
const { GRATIO_URL, GRATIO_ID, GRATIO_TOKEN } = process.env;
const base = `${GRATIO_URL}/waInstance${GRATIO_ID}`;
const url = `${base}/getCapabilities/${GRATIO_TOKEN}`;
const response = await fetch(url);
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/getCapabilities/' . getenv('GRATIO_TOKEN');
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 90,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK для канала MAX:
{
"channel": "max", "integration": "unofficial", "transport": "websocket",
"buttons": false, "attachments": true, "send_files": true, "voice_in": true,
"reactions": true, "edit": true, "unsend": true, "quote": true, "typing": true,
"read_receipts": true, "call_events": true, "call_audio": false, "groups": true,
"history": true, "contacts": true, "check_account": true,
"phone_visible": "no", "max_text_len": 4000, "write_first": "yes"
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
channel |
string | площадка: max, telegram, whatsapp, email |
integration |
string | unofficial — сеанс пользователя, как приложение на компьютере; official — стандартный протокол (почта: IMAP и SMTP) |
transport |
string | как Gratio связан с площадкой, для справки |
buttons |
boolean | кнопки в сообщениях. Сейчас нет ни в одном канале: sendButtons отвечает 501 |
attachments |
boolean | приём файлов |
send_files |
boolean | отправка файлов |
voice_in |
boolean | приём голосовых |
reactions |
boolean | реакции: sendReaction |
edit |
boolean | правка своих сообщений: editMessage |
unsend |
boolean | удаление у всех: deleteMessage |
quote |
boolean | ответ цитатой (quotedMessageId) |
typing |
boolean | «печатает»: sendTyping |
read_receipts |
boolean | статусы прочтения исходящих |
call_events |
boolean | звонки приходят уведомлениями |
call_audio |
boolean | Gratio может ответить на звонок, позвонить и передать звук — см. Звонки: как это работает |
groups |
boolean | создание групп и управление участниками |
history |
boolean | история чата с площадки: getChatHistory |
contacts |
boolean | список чатов и контактов |
check_account |
boolean | поиск аккаунта по номеру: checkAccount |
phone_visible |
string | виден ли номер собеседника: yes, no, masked |
max_text_len |
integer | предел длины текста, символов |
write_first |
string | можно ли начать диалог первым: yes, with_consent, never |
Особенности каналов
Значения по каналам:
| Поле | MAX | Telegram | Почта | |
|---|---|---|---|---|
integration |
unofficial |
unofficial |
unofficial |
official |
transport |
websocket |
mtproto |
websocket |
imap_idle |
buttons |
false |
false |
false |
false |
attachments, send_files |
true |
true |
true |
true |
voice_in |
true |
true |
true |
false |
reactions, edit, unsend, typing |
true |
true |
true |
false |
quote |
true |
true |
true |
true — ответ в цепочку письма |
read_receipts |
true |
true |
true |
false |
call_events |
true |
true |
true |
false |
call_audio |
true, если у канала включён звук звонков |
false |
true, если у номера включён звук звонков |
false |
groups |
true |
true |
true |
false |
history, contacts |
true |
true |
true |
true |
check_account |
true |
true |
true |
false |
phone_visible |
no |
no |
yes, кроме скрытых номеров @lid |
no |
max_text_len |
4000 |
4096 |
65536 |
100000 |
write_first |
yes |
yes |
yes |
yes |
Геопозицию, контакт, опрос, пересылку, архив и закрепы getCapabilities не описывает. Где они есть — в статье Возможности каналов.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
not_started |
канал ещё запускается | повторить через несколько секунд |
Что дальше
- Возможности каналов — сводная таблица по всем методам.
- getStateInstance — на связи ли канал прямо сейчас.
- Ответы и ошибки — что делать с
501 not_supported.
