Перейти к содержимому

copyMessages

Обновлено 17 октября 2026

Содержание
  1. Параметры
  2. Пример запроса
  3. Пример ответа
  4. Поля ответа
  5. Ошибки
  6. Что дальше

Копирует письма в другую папку, оригиналы остаются на месте. В ответе — номера копий в папке назначения, если сервер их сообщает.
Запрос POST /waInstance{idInstance}/copyMessages/{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/copyMessages/$GRATIO_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"folder": "inbox", "uids": [1540], "to": "archive"}'

Python

import os
import requests

BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]

url = f"{BASE}/copyMessages/{TOKEN}"
payload = {"folder": "inbox", "uids": [1540], "to": "archive"}
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}/copyMessages/${GRATIO_TOKEN}`;
const payload = { folder: "inbox", uids: [1540], to: "archive" };
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 . '/copyMessages/' . getenv('GRATIO_TOKEN');
$payload = ['folder' => 'inbox', 'uids' => [1540], 'to' => 'archive'];

$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": "Archive", "copied": [{"folder": "INBOX", "uid": 1540, "newUid": 821}]}

Поля ответа

Поле Тип Описание
folder string папка назначения — имя на сервере
copied array скопированные письма
copied[].folder, copied[].uid string, integer оригинал
copied[].newUid integer номер копии; null — сервер его не сообщает (нет UIDPLUS)

У копии тот же Message-ID и тот же idMessage, что у оригинала. Чтобы работать именно с копией, указывайте её folder и uid.

Ошибки

Код 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 канал — не почта вызвать у канала «Почта»

Общие правила — в статье Ответы и ошибки.

Что дальше

Была ли статья полезна?

Похожие статьи