Возвращает ссылку на письмо целиком — файл .eml (message/rfc822) со всеми заголовками, текстом и вложениями, как оно лежит в ящике. Нужен для архива, своего разбора писем или вложения в карточку обращения.
| Запрос | POST /waInstance{idInstance}/getEmailRaw/{apiTokenInstance} |
| Тело | JSON |
| Каналы | почта |
Параметры
Письмо — одним из способов, подробно — в статье Почта через API:
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
folder + uid |
string, integer | одно из трёх | папка и номер письма в ней |
idMessage |
string | одно из трёх | id письма. С chatId письмо найдётся и по журналу канала |
messageId |
string | одно из трёх | заголовок Message-ID |
chatId |
string | нет | адрес собеседника — вместе с idMessage |
Пример запроса
Письмо из «Входящих» по номеру:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/getEmailRaw/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"folder": "inbox", "uid": 1540}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/getEmailRaw/{TOKEN}"
payload = {"folder": "inbox", "uid": 1540}
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}/getEmailRaw/${GRATIO_TOKEN}`;
const payload = { folder: "inbox", uid: 1540 };
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 . '/getEmailRaw/' . getenv('GRATIO_TOKEN');
$payload = ['folder' => 'inbox', 'uid' => 1540];
$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:
{"downloadUrl": "https://api.gratio.net/media/7100000001/maria@client.ru/7877cd439c05bc16617b/999/a7d0…", "size": 52817}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
downloadUrl |
string | ссылка на файл .eml. Скачивается обычным GET, без ключа канала |
size |
integer | размер файла, байт |
Та же ссылка есть в ответе getEmail — поле rawUrl.
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
не указано письмо | добавить idMessage, или folder и uid, или messageId |
400 |
not_found |
письма нет | указать folder и uid из getMessages |
400 |
folder_not_found |
нет папки folder |
проверить getFolders |
400 |
not_authorized |
ящик не подключён | подключить ящик: connectMailbox |
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- getEmail — письмо, разобранное на текст, html и вложения.
- forwardEmail — переслать письмо целиком файлом.
- Файлы и ссылки на них — как работают ссылки на файлы.
