Отправляет файл, который лежит по публичной ссылке: Gratio скачивает его сам и отправляет так же, как sendFileByUpload. Ссылку из uploadFile Gratio берёт из своего хранилища, без повторного скачивания.
| Запрос | POST /waInstance{idInstance}/sendFileByUrl/{apiTokenInstance} |
| Тело | JSON |
| Каналы | MAX, Telegram, WhatsApp, почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
chatId |
string | да | получатель: личный чат, группа или номер 79991234567@c.us — см. Идентификаторы чатов и сообщений |
urlFile |
string | да | ссылка http(s) на публичный адрес, до 100 МБ; или urlFile из ответа uploadFile |
fileName |
string | нет | имя файла у получателя; без него — из ссылки |
caption |
string | нет | подпись под файлом; у почты — текст письма |
quotedMessageId |
string | нет | ответить цитатой на сообщение этого же чата |
clientMessageId |
string | нет | ваш ключ от дублей — см. Надёжная отправка без дублей. Повтор с тем же ключом файл заново не скачивает |
Тип файла Gratio берёт из заголовка Content-Type ответа сервера, а без него — определяет по имени файла.
Пример запроса
Прайс в PDF со своего сайта, с понятным именем файла:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/sendFileByUrl/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "79991234567@c.us",
"urlFile": "https://example.ru/files/price.pdf",
"fileName": "Прайс.pdf",
"caption": "Актуальный прайс на ноябрь",
"clientMessageId": "price-nov-79991234567"
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/sendFileByUrl/{TOKEN}"
payload = {
"chatId": "79991234567@c.us",
"urlFile": "https://example.ru/files/price.pdf",
"fileName": "Прайс.pdf",
"caption": "Актуальный прайс на ноябрь",
"clientMessageId": "price-nov-79991234567",
}
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}/sendFileByUrl/${GRATIO_TOKEN}`;
const payload = {
chatId: "79991234567@c.us",
urlFile: "https://example.ru/files/price.pdf",
fileName: "Прайс.pdf",
caption: "Актуальный прайс на ноябрь",
clientMessageId: "price-nov-79991234567",
};
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 . '/sendFileByUrl/' . getenv('GRATIO_TOKEN');
$payload = [
'chatId' => '79991234567@c.us',
'urlFile' => 'https://example.ru/files/price.pdf',
'fileName' => 'Прайс.pdf',
'caption' => 'Актуальный прайс на ноябрь',
'clientMessageId' => 'price-nov-79991234567',
];
$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:
{
"idMessage": "117428956522361912",
"urlFile": "https://api.gratio.net/media/7100000001/8695836/117428956522361912/0/d8f9…"
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
idMessage |
string | id отправленного сообщения |
urlFile |
string | ссылка на отправленный файл в хранилище Gratio, подписанная, без токена — см. Файлы и ссылки на них |
Ещё примеры
Файл из uploadFile
Подставьте urlFile из ответа uploadFile:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/sendFileByUrl/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"chatId": "8695836",
"urlFile": "https://api.gratio.net/upload/7100000001/5f2c8e1a9b3d4c7e6a0f1b2c/…/poster.jpg",
"caption": "Открытый урок в субботу, 11:00"
}'
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет chatId или urlFile |
добавить поле |
400 |
bad_url |
ссылка не http(s) или ведёт во внутреннюю сеть |
дать публичную ссылку |
400 |
url_unavailable |
сервер по ссылке ответил ошибкой | проверить ссылку |
400 |
file_too_large |
файл больше 100 МБ | уменьшить файл |
400 |
file_empty |
по ссылке пустой ответ | дать прямую ссылку на файл |
400 |
upload_failed |
мессенджер не принял файл | повторить или отправить в другом формате |
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 |
503 |
outcome_unknown |
связь оборвалась посреди отправки | повторить с тем же clientMessageId |
Особенности каналов
- Ссылка. Перенаправлений Gratio не выполняет: дайте прямую ссылку на файл, а не на страницу скачивания или короткую ссылку.
- Как уходит файл — так же, как у sendFileByUpload: картинка — фото, видео — видео, OGG/Opus в Telegram и WhatsApp — голосовым, остальное — документом.
- Почта. Письмо с файлом во вложении,
caption— текст письма. Письмо целиком — до 20 МБ.
Что дальше
- uploadFile — загрузить файл один раз и отправлять многим.
- Файлы и ссылки на них — где хранятся файлы и как устроены ссылки.
- outgoingMessageStatus — узнать, что файл получен и прочитан.
