Перейти к содержимому

Приостановка одиночной SMS ​

sms-pause · POST /api/json/2020-01-01 · Все действия

Принимается для отдельной SMS в ready без текущей обработки и без предыдущей паузы. status остается ready, paused=true. Сообщение внутри рассылки отдельно поставить на паузу нельзя. Эта операция не проверяет expire и не продлевает срок жизни.

Запрос ​

ПолеТипОбязательноПравило
idstringДа24 строчных шестнадцатеричных символа; документ должен быть доступен владельцу ключа.

Иллюстративный запрос (ключ и ID замените собственными):

json
{
  "api_key": "00000000-0000-0000-0000-000000000001",
  "action": "sms-pause",
  "data": {
    "id": "000000000000000000000001"
  }
}

Результат ​

data — объект; поля описаны в общем контракте результатов.

json
{
  "success": true,
  "data": {
    "id": "000000000000000000000001",
    "created": "2026-10-11T12:00:00+00:00",
    "updated": "2026-10-11T12:00:00+00:00",
    "signature": "TestSMS",
    "phone": "+79401234567",
    "message": "Проверка связи",
    "parts": 1,
    "price": 2.49,
    "total": 2.49,
    "status": "ready",
    "paused": true,
    "paid": true
  }
}

Отказы ​

Общие ошибки запроса и доступа применяются ко всем действиям. Неизвестные поля отклоняются; проверяйте success даже при HTTP 200.

КодПричина
SMS-PAUSE-ID-INVALID-FORMATИдентификатор SMS имеет недопустимый формат
SMS-PAUSE-ID-INVALID-TYPEИдентификатор SMS имеет недопустимый тип значения
SMS-PAUSE-ID-NOT-FOUNDSMS с таким идентификатором не найдено
SMS-PAUSE-ID-REQUIREDИдентификатор SMS не указан
SMS-PAUSE-REJECTEDЗапрос отклонен