Остановка сообщений
post
https://direct.i-dgtl/ru/api
/v1/message/stop
Остановка сообщений по uuid
Изменение статуса сообщений выполняется асинхронно: между успешным выполнением запроса и установкой сообщениям статуса unsent может пройти несколько секунд.
  • Данный запрос может быть выполнен как для одиночных сообщений, так и для сообщений рассылок
  • При выполнении успешной остановки корневого каскадного сообщения, весь каскад от данного сообщения будет остановлен

Описание объекта ответа

1
{
2
"errors": true,
3
"items": [
4
{
5
"messageUuid": "2a28d557-22a1-4be6-8908-1481723043dd",
6
"code": 200
7
},
8
{
9
"messageUuid": "063464ec-a34f-4558-90c5-984395000001",
10
"code": 202
11
},
12
{
13
"messageUuid": "811c27e3-3bc4-406a-9fcd-44435a8208da",
14
"code": 403
15
},
16
{
17
"messageUuid": "cc46e6b6-2d77-4457-aa81-c17a027721d3",
18
"code": 404
19
}
20
]
21
}
Copied!
Параметр
Тип
Описание
errors
boolean
Наличие фактов неуспешных остановок сообщений (наличие кодов 403, 404 в ответе)
items
array
Массив с объектами результатов остановки сообщений
items.messageUuid
string
Идентификатор сообщения
items.code
integer
Результат остановки сообщения:
  • 200 — сообщение будет остановлено гарантированно
  • 202 — сообщение будет остановлено не гарантированно, т.к. входит в стадию отправки / порождения каскадного сообщения
  • 403 — сообщение не может быть остановлено, т.к. находится в процессе отправки / уже отправлено
  • 404 — сообщение не остановлено, т.к. не найдено

Пример запроса

JSON
cURL
1
POST https://direct.i-dgtl.ru/api/v1/message/stop
2
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
3
Content-Type: application/json
4
{
5
"uuids": [
6
"2a28d557-22a1-4be6-8908-1481723043dd",
7
"811c27e3-3bc4-406a-9fcd-44435a8208da",
8
"cc46e6b6-2d77-4457-aa81-c17a027721d3"
9
]
10
}
Copied!
1
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message/stop' \
2
-H 'Content-Type: application/json' \
3
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
4
-d '{"uuids":["2a28d557-22a1-4be6-8908-1481723043dd","811c27e3-3bc4-406a-9fcd-44435a8208da","cc46e6b6-2d77-4457-aa81-c17a027721d3"]}'
Copied!