Переносит письма в другую папку — из одной или из разных. В ответе — новые номера писем в папке назначения, если сервер их сообщает. idMessage письма при переносе не меняется.
| Запрос | POST /waInstance{idInstance}/moveMessages/{apiTokenInstance} |
| Тело | JSON |
| Каналы | почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
messages, folder + uids, idMessages |
array | да, одно из | письма — до 500; одно письмо — folder + uid, idMessage или messageId. См. Почта через API |
to |
string | да | куда перенести: роль, имя на сервере или название папки |
chatId |
string | нет | адрес собеседника — если письма указаны по idMessage |
Пример запроса
Два письма из «Входящих» — в папку «Заявки»:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/moveMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"folder": "inbox", "uids": [1532, 1540], "to": "Заявки"}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/moveMessages/{TOKEN}"
payload = {"folder": "inbox", "uids": [1532, 1540], "to": "Заявки"}
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}/moveMessages/${GRATIO_TOKEN}`;
const payload = { folder: "inbox", uids: [1532, 1540], to: "Заявки" };
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 . '/moveMessages/' . getenv('GRATIO_TOKEN');
$payload = ['folder' => 'inbox', 'uids' => [1532, 1540], 'to' => 'Заявки'];
$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:
{
"folder": "&BBcEMARPBDIEOgQ4-",
"moved": [
{"folder": "INBOX", "uid": 1532, "newUid": 57},
{"folder": "INBOX", "uid": 1540, "newUid": 58}
]
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
folder |
string | папка назначения — имя на сервере |
moved |
array | перенесённые письма |
moved[].folder, moved[].uid |
string, integer | где письмо было |
moved[].newUid |
integer | номер письма в новой папке; null — сервер его не сообщает |
Письма, которые уже лежат в папке to, остаются на месте и в moved не попадают.
Особенности серверов
newUidсообщает сервер с возможностьюUIDPLUS. Без неё указывайте перенесённое письмо поidMessageилиmessageId.- Без возможности
MOVEGratio копирует письма, помечает их\Deletedи удаляет в старой папке. Если у сервера нет иUIDPLUS, вместе с ними удалятся другие письма этой папки, уже помеченные\Deletedв почтовой программе.
Что умеет сервер — serverCapabilities в getMailboxInfo.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет to; не указаны письма; писем больше 500 |
исправить запрос |
400 |
folder_not_found |
нет папки to или folder |
проверить getFolders |
400 |
not_found |
письма нет | указать folder и uid из getMessages |
400 |
mail_error |
сервер почты отказал | см. message — там ответ сервера |
400 |
not_authorized |
ящик не подключён | подключить ящик: connectMailbox |
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- copyMessages — скопировать, оставив письма на месте.
- deleteMessages — удалить письма.
- createFolder — создать папку назначения.
