Ставит или снимает три привычные отметки — «прочитано», «флажок» и «отвечено» — у одного письма или у 500 сразу. Отметки видны в почтовых программах сотрудников. Любые флаги и свои ключевые слова — setMessageFlags.
| Запрос | POST /waInstance{idInstance}/markMessages/{apiTokenInstance} |
| Тело | JSON |
| Каналы | почта |
Параметры
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
messages, folder + uids, idMessages |
array | да, одно из | письма — до 500; одно письмо — folder + uid, idMessage или messageId. См. Почта через API |
seen |
boolean | нет | true — прочитано, false — непрочитано |
flagged |
boolean | нет | true — поставить флажок, false — снять |
answered |
boolean | нет | true — отвечено, false — снять отметку |
chatId |
string | нет | адрес собеседника — если письма указаны по idMessage |
Нужна хотя бы одна из отметок seen, flagged, answered. Не указанная отметка не меняется.
Пример запроса
Два письма Марии — прочитаны:
curl
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/markMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"idMessages": [
"c62b698304229a98aad3",
"7877cd439c05bc16617b"
],
"seen": true
}'
Python
import os
import requests
BASE = f"{os.environ['GRATIO_URL']}/waInstance{os.environ['GRATIO_ID']}"
TOKEN = os.environ["GRATIO_TOKEN"]
url = f"{BASE}/markMessages/{TOKEN}"
payload = {
"idMessages": ["c62b698304229a98aad3", "7877cd439c05bc16617b"],
"seen": True,
}
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}/markMessages/${GRATIO_TOKEN}`;
const payload = {
idMessages: ["c62b698304229a98aad3", "7877cd439c05bc16617b"],
seen: true,
};
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 . '/markMessages/' . getenv('GRATIO_TOKEN');
$payload = [
'idMessages' => ['c62b698304229a98aad3', '7877cd439c05bc16617b'],
'seen' => true,
];
$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:
{"updated": 2}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
updated |
integer | сколько писем обработано |
Ещё примеры
Флажок и непрочитано
Вернуть письмо в работу — снять «прочитано» и поставить флажок:
curl -X POST "$GRATIO_URL/waInstance$GRATIO_ID/markMessages/$GRATIO_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"folder": "inbox",
"uids": [
1540
],
"seen": false,
"flagged": true
}'
Ошибки
| Код | code |
Когда | Что делать |
|---|---|---|---|
400 |
validation |
нет ни одной отметки; не указаны письма; писем больше 500 | исправить запрос |
400 |
not_found |
письма нет | указать folder и uid из getMessages |
400 |
folder_not_found |
нет папки folder |
проверить getFolders |
400 |
not_authorized |
ящик не подключён | подключить ящик: connectMailbox |
501 |
not_supported |
канал — не почта | вызвать у канала «Почта» |
Общие правила — в статье Ответы и ошибки.
Что дальше
- setMessageFlags — любые флаги и свои ключевые слова.
- readChat — все непрочитанные письма собеседника разом.
- searchMessages — найти письма с отметками или без.
