Отмена одиночной SMS

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

Принимает запрос отмены отдельной SMS в состоянии ready, если она доступна для изменения. Сообщения внутри рассылки отменяются через отмену рассылки. Ответ cancel подтверждает приём запроса; окончательный результат проверяйте запросом статуса. Для unpaid, reserve и enroute запрос отклоняется.

Запрос

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

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

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

Результат

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

{
  "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": "cancel",
    "paused": false,
    "paid": true
  }
}

Отказы

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

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