Возвращает состояние канала: подключён ли номер к мессенджеру и можно ли отправлять. Gratio отвечает сразу, без запроса к мессенджеру, — метод можно вызывать часто, например перед рассылкой.
| Запрос | GET /waInstance{idInstance}/getStateInstance/{apiTokenInstance} |
| Тело | нет |
| Каналы | MAX, Telegram, WhatsApp, почта |
Пример запроса
Проверить канал перед отправкой:
curl
curl "$GRATIO_URL/waInstance$GRATIO_ID/getStateInstance/$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}/getStateInstance/{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}/getStateInstance/${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 . '/getStateInstance/' . 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:
{"stateInstance": "authorized"}
Значения stateInstance
| Значение | Что значит | Что делать |
|---|---|---|
authorized |
номер на связи, канал работает | — |
starting |
запуск или переподключение, обычно несколько секунд | подождать authorized |
notAuthorized |
сеанса нет: номер не привязан, сеанс завершили на телефоне или площадка его отозвала | привязать номер в кабинете |
wrongAccount |
в сеансе другой аккаунт, а не тот, что был привязан к каналу. Отправки нет | отключить номер в кабинете и привязать прежний |
Пока канал не authorized, методы, которым нужен мессенджер, отвечают 400 not_authorized. Входящие за время простоя не теряются: после переподключения Gratio дочитает их сам. Если догнать не удалось, придёт уведомление syncGap.
Особенности каналов
| Канал | Когда бывает notAuthorized |
|---|---|
| MAX | веб-сеанс Gratio завершили в «Устройствах» MAX или MAX его отозвал |
| Telegram | сеанс Gratio завершили в «Устройствах» или Telegram его сбросил |
| устройство отвязали на телефоне или WhatsApp заблокировал номер; подробность — в кабинете | |
| Почта | ящик перестал принимать вход: сменили пароль или отозвали доступ |
Тот же аккаунт после новой привязки сохраняет ключ канала и историю.