Пересылает сообщения из одного чата в другой — как «Переслать» в приложении: с файлами и пометкой о пересылке. Работает в Telegram и WhatsApp; у почты пересылает письма.
| Запрос | POST /waInstance{idInstance}/forwardMessages/{apiTokenInstance} |
| Тело | JSON |
| Каналы | Telegram, WhatsApp, почта. MAX — 501 |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | куда переслать: личный чат, группа или номер 79991234567@c.us — см. Идентификаторы чатов и сообщений |
chatIdFrom |
string | да | из какого чата: адрес чата из уведомления или истории. Поиска по номеру здесь нет |
messages |
array | да | idMessage сообщений, которые переслать, по порядку |
clientMessageId |
string | нет | ваш ключ от дублей. Повтор запроса с тем же ключом вернёт те же id и ничего не перешлёт заново |
Пример запроса
Переслать в группу Telegram два сообщения из личного чата, с ключом от дублей:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/forwardMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "-1001234567890",
"chatIdFrom": "8617393401",
"messages": [
"4815",
"4816"
],
"clientMessageId": "fwd-8617393401-4815"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/forwardMessages/{TOKEN}"
payload = {
"chatId": "-1001234567890",
"chatIdFrom": "8617393401",
"messages": ["4815", "4816"],
"clientMessageId": "fwd-8617393401-4815",
}
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}/forwardMessages/${GRATIO_TOKEN}`;
const payload = {
chatId: "-1001234567890",
chatIdFrom: "8617393401",
messages: ["4815", "4816"],
clientMessageId: "fwd-8617393401-4815",
};
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 . '/forwardMessages/' . getenv('GRATIO_TOKEN');
$payload = [
'chatId' => '-1001234567890',
'chatIdFrom' => '8617393401',
'messages' => ['4815', '4816'],
'clientMessageId' => 'fwd-8617393401-4815',
];
$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:
{"messages": ["9921", "9922"]}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
messages |
array | idMessage новых сообщений в чате chatId — в том же порядке, что в запросе |
Каждое пересланное — отдельное сообщение: на каждое приходят outgoingAPIMessageReceived и статус outgoingMessageStatus sent.
Ещё примеры
Переслать сообщение клиента в рабочую группу:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/forwardMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "120363012345678901@g.us",
"chatIdFrom": "79991234567@c.us",
"messages": [
"3EB0C767D26A1D5A6F0B"
]
}'
Письмо
У почты письмо пересылается на адрес chatId:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/forwardMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "director@school.ru",
"chatIdFrom": "maria@client.ru",
"messages": [
"c62b698304229a98aad3"
]
}'
Если пересылка оборвалась
Сообщения уходят по одному. Если площадка отказала на одном из них, предыдущие уже пересланы, а запрос вернёт ошибку. Повторите запрос с тем же clientMessageId: уже пересланные Gratio не отправит второй раз, только оставшиеся. Без ключа повтор перешлёт всё заново.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId, chatIdFrom или messages; messages — не массив или пустой |
исправить запрос |
400 |
not_found |
сообщения нет в чате chatIdFrom |
проверить idMessage и чат |
400 |
not_forwardable |
WhatsApp не пересылает это сообщение | отправить содержимое заново |
400 |
not_authorized |
канал не на связи | проверить getStateInstance |
400 |
no_account |
на номере …@c.us нет аккаунта в этом мессенджере |
выбрать другой канал |
402 |
payment_required |
канал на паузе за неоплату | продлить канал в кабинете |
409 |
idempotency_conflict |
тот же clientMessageId с другим набором сообщений |
новый ключ для новой пересылки |
429 |
too_frequent и другие |
темп канала, правило WhatsApp, суточный предел писем | повторить после Retry-After |
469 |
rate_limited |
Telegram попросил паузу | повторить после Retry-After |
501 |
not_supported |
канал MAX | — |
503 |
outcome_unknown |
связь оборвалась посреди отправки | повторить с тем же clientMessageId |
Особенности каналов
- Telegram. Сообщение уходит с подписью автора, как «Переслать» в приложении.
- WhatsApp. Переслать можно сообщения, которые канал видел с момента привязки. Файлы уходят без повторной загрузки, с пометкой «Переслано»; цитата оригинала не пересылается.
- Почта.
messages— id писем; каждое пересылается на адресchatIdс вложениями. Переслать со своим текстом и копией — forwardEmail. - MAX —
501 not_supported.
Что дальше
- Ссылка и пересланное — как приходят пересланные сообщения.
- forwardEmail — пересылка письма со своим текстом.
- Надёжная отправка без дублей — как работает
clientMessageId.
