Интеграция с сервисом (HTTP/HTTPS API)

  • Зарегистрируйтесь на сайте или войдите в личный кабинет, если уже зарегистрировались;
  • Перейдите в настройки API и включите API;
  • Ознакомьтесь с методами API ниже;
  • Скопируйте ключ API и используйте его для авторизации (Bearer token в заголовке Authorization);
  • Для методов Подключение номера и Отправить сообщение пополните баланс;

Описание методов API

Image

Аутентификация

Все запросы API (кроме /api/login, /api/register и /api/public/*) требуют авторизации через Bearer token:

Authorization: Bearer <api_token>

Базовый URL: https://sms-numbers.co/api


API для работы с номерами

GET Список номеров

Данный метод возвращает список номеров для Вашего аккаунта

GET https://sms-numbers.co/api/numbers

Заголовки: Authorization: Bearer <api_token>

Параметры запроса: filter (string) — Опционально фильтр по статусу (напр. active)


GET Информация о номере

Возвращает информацию о конкретном номере.

GET https://sms-numbers.co/api/number/{id}

Параметры пути: id (integer) — ID номера из списка.


GET Поиск номеров доступных для подключения

Данный метод возвращает список номеров доступных для подключения

GET https://sms-numbers.co/api/numbers/search/{iso}

Параметры пути: iso (string) — двухбуквенный код страны (напр. ru, us).

Тарифы: GET https://sms-numbers.co/api/public/countries и GET https://sms-numbers.co/api/public/prices/{country_id}.


POST Подключение номера

Данный метод позволяет подключить выбранный номер

POST https://sms-numbers.co/api/number/buy

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Тело: id (integer) — ID номера для подключения (из результатов поиска).


POST Отключение номера

Данный метод позволяет отключить выбранный номер

POST https://sms-numbers.co/api/number/cancel

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Тело: id (integer) — ID номера для отключения (из списка номеров).


POST Изменение настроек номера

Данный метод позволяет настроить переадресацию сообщений для выбранного номера

POST https://sms-numbers.co/api/number/update

Заголовки: Authorization: Bearer <api_token>, Content-Type: application/json

Параметры тела: id (обязательный), email, number, user_tag (опционально).


API для сообщений

GET https://sms-numbers.co/api/messages — Список сообщений

GET https://sms-numbers.co/api/app/messages — Диалоги (группированные)

GET https://sms-numbers.co/api/app/messages/{number} — Сообщения по номеру

POST https://sms-numbers.co/api/message/send — Отправить SMS (from, to, body)


Аккаунт и платежи

GET https://sms-numbers.co/api/account/profile — Профиль

GET https://sms-numbers.co/api/account/balance — Баланс

GET https://sms-numbers.co/api/payments — История платежей

POST https://sms-numbers.co/api/payment/create — Создать платёж


Публичные эндпоинты (без авторизации)

GET https://sms-numbers.co/api/public/countries — Список стран

GET https://sms-numbers.co/api/public/countries/numbers — Страны с номерами

GET https://sms-numbers.co/api/public/services — Список услуг

POST https://sms-numbers.co/api/login — Вход (email, password)

POST https://sms-numbers.co/api/register — Регистрация


Ответы сервера

200 - OK Успешно.
400 - Bad Request Неверные параметры запроса.
401 - UnauthorizedНе авторизовано (неверный или отсутствующий токен).
402 - Request FailedПараметры верные, но запрос не успешен.
403 - ForbiddenЗапрещено.
404 - Not FoundЗапрошенный ресурс не найден.
429 - Too Many RequestsИсчерпан лимит запросов.
500, 502, 503, 504 - Server ErrorsОшибка на стороне сервера.

Успешный ответ: {"success": true, "data": {...}, "message": "..."}

Ошибка: {"success": false, "message": "...", "data": {...}}

Sign up icon

Регистрация

Зарегистрируйтесь сейчас, подтвердите e-mail и получите деньги на счёт для тестирования номеров