HTTP/HTTPS API

Подключайте номера, принимайте и отправляйте SMS из своего сервиса. Авторизация по Bearer-токену, JSON-ответы, публичные методы без ключа.

API

Быстрый старт

1
Создайте аккаунт или войдите в кабинет.
2
Включите API в настройках и скопируйте токен.
3
Авторизация
Передавайте токен в заголовке Authorization.
4
Методы
Используйте эндпоинты ниже для номеров и SMS.
5
Баланс
Для покупки номера и отправки SMS пополните счёт.

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

Все запросы, кроме /api/login, /api/register и /api/public/*, требуют Bearer-токен.

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

Тело: id (integer) — ID номера из результатов поиска. Заголовки: Bearer-токен и Content-Type: application/json.

POST

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

Отключает выбранный номер.

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

Тело: id (integer) — ID номера из списка.

POST

Настройки номера

Переадресация входящих SMS и пользовательский тег.

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

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

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

GET

Список сообщений

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

Диалоги

Сообщения, сгруппированные по диалогам.

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

Сообщения по номеру

GET https://sms-numbers.co/api/app/messages/{number}
POST

Отправить SMS

POST https://sms-numbers.co/api/message/send

Тело: from, to, body.

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

GET

Профиль

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

Баланс

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

История платежей

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

Создать платёж

POST https://sms-numbers.co/api/payment/create

Публичные методы

Авторизация не нужна.

GET

Список стран

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

Страны с номерами

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

Список услуг

GET https://sms-numbers.co/api/public/services
POST

Вход

POST https://sms-numbers.co/api/login

Тело: email, password.

POST

Регистрация

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Ошибка на стороне сервера

Успех: {"success": true, "data": {...}, "message": "..."}

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

Sign up icon

Регистрация

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