Get

[POST] …/v1/SMS/Get

Возвращает информацию о единичных СМС сообщении.

Входные параметры

Название Тип данных Обязательность Описание
ids Array of Int64 Необязательный Массив ID единичных СМС
entity_type Enum Необязательный Тип получателя СМС: <RetailCustomer | 1> - Розничный покупатель, <Partner | 2> - Контрагент
entity_id Int64 Необязательный. Если entity_type не задан - игнорируется ID получателя СМС
status Enum Необязательный Статус отправки СМС: <New | 1> - Создано, <Sended | 2> - Отправлено, <Delivered | 3> - Доставлено, <Error | 4> - Ошибка отправки
limit Int32 Необязательный Количество возвращаемых элементов выборки
offset Int32 Необязательный Смещение от начала выборки

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

{
    "ids": [1],
    "entity_type": "RetailCustomer",
    "entity_id": 1,
    "status": "New",
    "limit": 1,
    "offset": 0
}

Выходные параметры

Название Тип данных Описание
result Array of Sms Массив СМС
next_offset Int32 Смещение для следующей выборки данных
total Int32 Количество элементов выборки

Пример ответа

{
    "ok": true,
    "result": [
        {
            "id": 1,
            "entity_type": "RetailCustomer",
            "entity_id": 1,
            "date": 1712345678,
            "status": "New",
            "phone": "998123456789",
            "message": "example",
            "last_update": 1712345678,
        }
    ],
    "next_offset": 1,
    "total": 2
}