Отключает ящик от канала «Почта». Gratio удаляет у себя пароль или ключи сервиса, приём писем останавливается, канал переходит в notAuthorized. Ключ канала не меняется: подключите тот же или другой ящик методом connectMailbox или в кабинете.
| Запрос | POST /waInstance{idInstance}/disconnectMailbox/{apiTokenInstance} |
| Тело | JSON, пустой объект {} |
| Каналы | почта |
Пример запроса
Отключить ящик канала:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/disconnectMailbox/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/disconnectMailbox/{TOKEN}"
payload = {}
response = requests.post(url, json=payload, 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}/disconnectMailbox/${GRATIO_TOKEN}`;
const payload = {};
const response = await fetch(url, {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify(payload),
});
console.log(response.status, await response.json());
PHP
<?php
$base = getenv('GRATIO_URL') . '/waInstance' . getenv('GRATIO_ID');
$url = $base . '/disconnectMailbox/' . getenv('GRATIO_TOKEN');
$payload = [];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($response);
Пример ответа
Ответ 200 OK:
{"disconnected": true, "detail": "Ящик отключён: данные для входа удалены у нас."}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
disconnected |
boolean | true — ящик отключён |
detail |
string | итог словами, для человека |
Что происходит после отключения
- Канал переходит в
notAuthorized, приходит уведомление stateInstanceChanged. - Методы ящика отвечают
400 not_authorized, пока ящик не подключат снова. - Письма в самом ящике не меняются.
- Доступ, выданный через сервис, Gratio удаляет у себя. Чтобы отозвать его и у сервиса, откройте настройки безопасности аккаунта Google, Microsoft, Яндекса или Mail.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- connectMailbox — подключить ящик снова.
- getStateInstance — состояние канала.
- stateInstanceChanged — уведомление о смене состояния.
