Сервис управления смс

Общая информация

Сервис "SMS", который отвечает за отправку SMS-сообщений и верификацию кодов.

SMS

POST /send-sms/:phone

Описание: Отправка SMS сообщения с кодом подтверждения на указанный номер телефона.

Теги: SMS

Summary: Отправляет SMS сообщение с кодом подтверждения на указанный номер телефона.

Параметры запроса (path):

  • phone: (string, required) - Номер телефона на который будет отправлено сообщение.

Тело запроса (body):

{
  "token": "some_token",
   "type": "recaptcha"
}
  • token: (string, optional) - reCaptcha token
  • type: (string, optional) - reCaptcha type

Ответ:

  • 200 OK:
    {
  "success": true,
  "expireAt": 1710501600000,
   "expireAtSeconds": 90,
  "message": "Код уже был отправлен",
  "code": "SMS_CODE_ALREADY_SENT"
}
  • success: (boolean) - Флаг успешной отправки SMS.
  • expireAt: (integer) - Время истечения срока действия кода (timestamp).
  • expireAtSeconds: (integer) - Оставшееся время до истечения (в секундах).
  • message: (string) - Статус отправки сообщения.
  • code: (string) - Код состояния
  • 400 Bad Request:
    {
 "success": false,
 "message": "Некорректный captcha или ошибка при отправке SMS"
}
  • Некорректный запрос или ошибка при отправке SMS.
  • 500 Internal Server Error:
    {
    "success": false,
    "error": "Внутренняя ошибка сервера"
}
  • Внутренняя ошибка сервера.

POST /verify-sms

Описание: Верификация SMS кода.

Теги: SMS

Summary: Проверяет правильность введенного кода подтверждения.

Тело запроса (body):

{
 "phone": "79991234567",
 "code": "1234"
}
  • phone: (string, required) - Номер телефона, на который был отправлен код. *code: (string, required) - Код для подтверждения (4 цифры).

Ответ:

  • 200 OK:
    {
  "success": true,
  "token": "some_token"
}
  • success: (boolean) - Флаг успешной верификации.
  • token: (string) - Токен доступа для пользователя.
  • 400 Bad Request:
    {
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Некорректный код или номер телефона"
 }
  • 401 Unauthorized:
    {
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Неверный код подтверждения"
}
  • 500 Internal Server Error:
    {
  "success": false,
  "error": "Внутренняя ошибка сервера"
}

Примечания:

  • Все запросы не требуют авторизации.
  • Все запросы возвращают 500 Internal Server Error в случае внутренней ошибки на сервере.
Table of Contents