Удаляет папку ящика. Письма в ней удаляются вместе с папкой и в «Корзину» не попадают — нужные сначала перенесите методом moveMessages. У Gmail папка — это ярлык: письма останутся во «Вся почта». «Входящие» удалить нельзя.
| Запрос | POST /waInstance{idInstance}/deleteFolder/{apiTokenInstance} |
| Тело | JSON |
| Каналы | почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
folder |
string | да | папка: роль, имя на сервере или название |
Пример запроса
Удалить папку «Заявки сайта»:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/deleteFolder/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"folder": "Заявки сайта"}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/deleteFolder/{TOKEN}"
payload = {"folder": "Заявки сайта"}
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}/deleteFolder/${GRATIO_TOKEN}`;
const payload = { folder: "Заявки сайта" };
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 . '/deleteFolder/' . getenv('GRATIO_TOKEN');
$payload = ['folder' => 'Заявки сайта'];
$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:
{"deleted": true}
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет folder |
добавить поле |
400 |
folder_not_found |
нет такой папки | проверить getFolders |
400 |
bad_folder |
папка — «Входящие» | — |
400 |
mail_error |
сервер почты отказал: например, в папке есть вложенные папки | см. message — там ответ сервера |
400 |
not_authorized |
ящик не подключён | подключить ящик: connectMailbox |
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- moveMessages — перенести письма перед удалением.
- getFolders — все папки ящика.
