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 та отримайте тестові кошти для перевірки номерів