Остановка сообщений

Остановка сообщений#

Остановка сообщений по uuid#

POST https://direct.i-dgtl.ru/api/v1/message/stop

Метод позволяет безвозвратно отменить отправку одиночных сообщений с переданными идентификаторами.

Headers#

Name

Type

Description

Authorization*

string

Basic {TOKEN_1}

Content-Type*

string

application/json

Request Body#

Name

Type

Description

uuids*

array

Массив идентификаторов сообщений; допускается не более 10000 значений.

В случае корректного запроса в ответе будут перечислены статусы остановки сообщений.

{
  "errors": true,
  "items": [
    {
      "messageUuid": "2a28d557-22a1-4be6-8908-1481723043dd",
      "code": 201
    },
    {
      "messageUuid": "811c27e3-3bc4-406a-9fcd-44435a8208da",
      "code": 403
    },
    {
      "messageUuid": "cc46e6b6-2d77-4457-aa81-c17a027721d3",
      "code": 404
    }
  ]
}

Использование невалидного токена / отсутствие заголовка авторизации.

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

{
    "error": {
        "code": 4010,
        "msg": "Not Authenticated"
    }
}

Использование неподходящего токена.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

{% hint style=»warning» %} Изменение статуса сообщений выполняется асинхронно: между успешным выполнением запроса и установкой сообщениям статуса unsent может пройти несколько секунд. {% endhint %}

{% hint style=»info» %}

  • Данный запрос может быть выполнен как для одиночных сообщений, так и для сообщений рассылок

  • При выполнении успешной остановки корневого каскадного сообщения, весь каскад от данного сообщения будет остановлен {% endhint %}

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

{
  "errors": true,
  "items": [
    {
      "messageUuid": "2a28d557-22a1-4be6-8908-1481723043dd",
      "code": 200
    },
    {
      "messageUuid": "063464ec-a34f-4558-90c5-984395000001",
      "code": 202
    },
    {
      "messageUuid": "811c27e3-3bc4-406a-9fcd-44435a8208da",
      "code": 403
    },
    {
      "messageUuid": "cc46e6b6-2d77-4457-aa81-c17a027721d3",
      "code": 404
    }
  ]
}

Параметр

Тип

Описание

errors

boolean

Наличие фактов неуспешных остановок сообщений (наличие кодов 403, 404 в ответе)

items

array

Массив с объектами результатов остановки сообщений

items.messageUuid

string

Идентификатор сообщения

items.code

integer

Результат остановки сообщения:

  • 200 — сообщение будет остановлено гарантированно
  • 202 — сообщение будет остановлено не гарантированно, т.к. входит в стадию отправки / порождения каскадного сообщения
  • 403 — сообщение не может быть остановлено, т.к. находится в процессе отправки / уже отправлено
  • 404 — сообщение не остановлено, т.к. не найдено

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

POST https://direct.i-dgtl.ru/api/v1/message/stop
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
{
  "uuids": [
    "2a28d557-22a1-4be6-8908-1481723043dd",
    "811c27e3-3bc4-406a-9fcd-44435a8208da",
    "cc46e6b6-2d77-4457-aa81-c17a027721d3"
  ]
}

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