Руководство разработчика

Документация для разработчиков

SMS Activate предлагает полностью автоматизированный API для пользователей, которым нужна аренда временных номеров в больших объёмах.

Create an API key in your dashboard and send it in the X-API-KEY header to https://api.smsactivate.uk. Order a number with POST /get_numbers using a service code and numeric country ID, then poll GET /status/{order_id} for the code. This API receives codes on a number you order. It does not send codes to your own users.

Начало работы

Создайте API-ключ в кабинете и используйте его в серверном запросе.

Никогда не размещайте действующий API-ключ в коде браузера, на скриншотах или в публичных репозиториях.

Открыть API-ключи

What does a first integration look like, end to end?

Start with GET /balance. A failed first call usually means the key or header is wrong.

Check what is live before you order: GET /services for service codes, GET /countries/{service} for country IDs, GET /offers/{service}/{country} for current offers. Availability changes; the catalog here is a reference, not a promise of stock. Browse all services.

POST /get_numbers with service and country. The response gives you an order id and a phone number; save the id.

Poll GET /status/{order_id} until the status reads received, then read sms_code.

What happens to an order after you place it?

An order moves through states, and what you can do depends on the state.

Active means the number is waiting for an SMS. While active you can ask for another SMS with POST /resend/{order_id} on a supported activation, or cancel an eligible one with POST /cancel/{order_id}. Cancel only works 2 to 20 minutes after purchase, and only before an SMS arrives.

Received means the code arrived. An expired order ran out its 20-minute window with no SMS and returns its stored status. An eligible activation that receives no SMS is refunded to your wallet. Read the FAQ.

Check the cancel response before you retry anything. If a purchase response is uncertain, do not order again until its status is clear. Contact support.

What mistakes cost first-time integrators the most?

Putting the key in browser code or a public repo. Keep it on a server you control.

Ordering before checking availability. GET /offers/{service}/{country} first saves a failed order.

Polling without a stop. GET /sms/{order_id} is rate-limited, so use GET /status/{order_id} and stop at a final state: received, cancelled, expired or refunded.

Retrying a purchase that came back uncertain. A 503 can mean the order went through and the answer got lost. Contact support.

Reusing an idempotency key for a different purchase. Use the same key only to check the outcome of the same purchase request.

Assuming the code will be accepted. Acceptance is the receiving service's decision, not ours.

Buying a one-time activation for an account that will ask for a code again - rentals are for that: 24 to 1,344 hours on the same number.

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

Получите API-ключ в настройках личного кабинета. Все запросы к API должны содержать заголовок:

X-API-KEY: your_api_key_here

2. Базовый URL

Все запросы к API используют этот базовый URL:

https://api.smsactivate.uk

Пример запроса

Этот запрос создаёт заказ и может списать средства с кошелька. Замените пример сервиса и страны на выбор, доступный в вашем аккаунте.

curl -X POST https://api.smsactivate.uk/get_numbers   -H "X-API-KEY: YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{"service":"tg","country":2}'

Справочник API

Для каждой операции указаны входные данные, пример запроса, типичный ответ и основные ошибки. Существующие интеграции API могут и дальше использовать прежние endpoint-ы; для новых интеграций рекомендуются endpoint-ы по продуктам ниже. В примерах используются условные ID и значения. Отправляйте авторизованные запросы с вашего сервера с заголовком API-ключа.

Начало работы

GET/balanceУзнайте текущий баланс кошелька.

Требуется API-ключ.

Параметры

Нет
Параметров запроса нет.

Пример запроса

curl https://api.smsactivate.uk/balance -H "X-API-KEY: YOUR_API_KEY"

Ответ

{ "balance": "10.0000" }

Errors

Endpoint возвращает текущий баланс авторизованного аккаунта.

Получение и управление номером

POST/get_numbersСоздайте заказ активации.

Требуется API-ключ.

Параметры

service
Обязательная строка. Код сервиса, например tg.
country
Обязательное целое число. Числовой ID страны.
operator
Необязательная строка. По умолчанию any.
max_price
Необязательное число. Максимальная цена; также принимается maxPrice.
min_price
Необязательное число; также принимается minPrice.
any_price
Необязательное логическое значение; также принимается anyPrice.
product
Необязательно: standard (по умолчанию) или api_links. API Links - это покупки инвентаря без возврата.
idempotency_key
Необязательный UUID для стандартных активаций. Используйте один и тот же ключ повторно только для того же запроса на покупку, когда проверяется его результат.
quantity
Необязательное целое число от 1 до 100 для заказов инвентаря API Links; по умолчанию 1. Заказы стандартной активации - это всегда один номер.

Пример запроса

curl -X POST https://api.smsactivate.uk/get_numbers \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service":"tg","country":2}'

Ответ

{
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": "0.2500",
  "balance_remaining": "9.7500"
}

Errors

HTTP 400: выбор недоступен, лимит цены или недостаточно средств. HTTP 409: предыдущий заказ ещё проверяется. HTTP 503: временный сбой или неопределённый заказ; если в ответе сказано, что требуется сверка, не повторяйте запрос и обратитесь в поддержку.

GET/sms/{order_id}Запросите новую проверку статуса активного заказа.

Требуется API-ключ. Для этого endpoint действует ограничение частоты запросов.

Параметры

order_id
Обязательное значение пути, возвращённое при создании заказа.

Пример запроса

curl https://api.smsactivate.uk/sms/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

HTTP 400: проверка SMS недоступна для этого заказа. HTTP 404: заказ не найден. HTTP 502: временный сбой проверки. Для истёкших заказов возвращается сохранённый статус без новой внешней проверки.

GET/status/{order_id}Узнайте статус заказа и полученные SMS.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути, возвращённое при создании заказа.

Пример запроса

curl https://api.smsactivate.uk/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

Ответ относится к заказу авторизованного аккаунта. Если запрос статуса не удался, API возвращает ошибку; проверьте ID заказа и повторите позже, если сервис временно недоступен.

POST/resend/{order_id}Запросите ещё одно SMS для поддерживаемой активной активации.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути. Тела запроса нет.

Пример запроса

curl -X POST https://api.smsactivate.uk/resend/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

{ "message": "Resend request successful. Waiting for new SMS." }

Errors

HTTP 400: повторная отправка не принята или заказ истёк. HTTP 409: повторная отправка недоступна для этого заказа. HTTP 500: повторную отправку не удалось выполнить.

POST/cancel/{order_id}Запросите отмену подходящей активации.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути. Тела запроса нет.

Пример запроса

curl -X POST https://api.smsactivate.uk/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "message": "Number cancelled and balance refunded",
  "refunded_amount": "0.2500",
  "new_balance": "10.0000"
}

Errors

Отмена доступна только для подходящих активных активаций, через 2–20 минут после покупки и до получения SMS. Аренда отменяется через /rent/cancel/{order_id}; API Links - без возврата. Неподходящие или неподтверждённые отмены возвращают ошибку. Прочитайте ответ на отмену, прежде чем повторять запрос.

GET/reactivate/{order_id}/optionsУзнайте текущую цену и детали реактивации.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути исходного заказа.

Пример запроса

curl https://api.smsactivate.uk/reactivate/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "price": 0.25,
  "duration": 20,
  "phone": "10000000000",
  "service": "tg",
  "country": 2
}

Errors

HTTP 400: реактивация не поддерживается или недоступна. HTTP 409: реактивация недоступна для этого заказа. HTTP 503: не удалось подтвердить актуальную цену.

POST/reactivate/{order_id}Реактивируйте подходящую активацию по текущей цене.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути исходного заказа. Тела запроса нет.

Пример запроса

curl -X POST https://api.smsactivate.uk/reactivate/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "message": "Number reactivated successfully.",
  "id": "NEW_ORDER_ID",
  "phone": "10000000000",
  "price": 0.25,
  "balance_remaining": 9.75
}

Errors

HTTP 400: реактивация не поддерживается или недостаточно средств в кошельке. HTTP 409: недоступно для этого заказа. HTTP 503: результат не удалось подтвердить; обратитесь в поддержку, прежде чем повторять.

GET/orders/{order_id}Получите сведения об одном из ваших заказов.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути, возвращённое при создании заказа.

Пример запроса

curl https://api.smsactivate.uk/orders/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the order record with buyer-facing fields, including its status and remaining time where applicable. Internal routing IDs and cost fields are not returned.

Errors

HTTP 404: заказ не найден или не принадлежит вашему аккаунту.

Выбор сервисов, стран и цен

СервисыИщите в каталоге сервисов по названию или коду. Наличие может меняться; проверьте актуальный endpoint перед заказом.
Название / код1,638 записей в каталоге
  • 163COMwp
  • 11688hn
  • 11and1ahs
  • 11xbetwj
  • 224bettinglh
  • 22dehandsapd
  • 22domainserc
  • 22ememainblx
  • 22ГИСbcg
  • 332Redqi
  • 3360Krediayo
  • 33Funauw
  • 44FunLitehk
  • 5500pxfpx
  • 551exchboc
  • 551exchangeexc
  • 77-Elevenaws
  • 8888casinoll
  • 9999 Mdbrv
  • 99acresfw
  • 99appki
  • 999Gameqkb
  • 999k Outletamq
  • AA23acv
  • AA9Agn
  • AAadharhra
  • Abastece-aíanb
  • AAbbottags
  • Ace2Threerh
  • AAcimacim
  • AAckoamf
  • AdaKamiko
  • AAdaModalbdo
  • AAdanibq
  • AAdidasan
  • AAditya Birlaqff
  • AAdmiralBetbst
  • AAdobebyh
  • Advertsagw
  • AAEG Presentsrsn
  • AAffirmbow
  • AAfreecaTVaip
  • AGIBANKsa
  • AAgodaag
  • AgriDevelopcs
  • AAgroinformqu
  • AAhlanbsm
  • AAiqfomebbi
  • AAir Milesbsy
  • AAirba Freshbnp
  • Airbnbuk
  • AAirtaskerbyd
  • Airtelzl
  • AAirtimeacy
  • AISwv
  • AAIS PLAYaxs
  • Aitujj
  • Akudorf
  • Akulakutm
  • Alchemyaav
  • Alfabt
  • Alfagiftbn
  • AAlfamidibgt
  • AAlFursanbxr
  • AAlgidalp
  • AAlibabaab
  • AliExpresshx
  • AAlignableaul
  • Alipay/Alibaba/1688hw
  • All Accessajy
  • Allegroyn
  • AlloBanknh
  • AAllofreshaeo
  • AAltyn-ial
  • AAmap 高德地图btx
  • AAmarthaFinbsv
  • Amasiayo
  • AAmaze Super Appbzk
  • Amazonam
  • AAme Digitalafi
  • AAmwayaee
  • AAngel Oneaha
  • Ankamaalg
  • AAnnoncelightbyw
  • Any Otherot
  • AOLpm
  • ApostaGanhaml
  • Applewx
  • Apteka Aprelaeh
  • AptekaRUgk
  • AAptekiPlusrq
  • AAR Lensaco
  • ArenaPlusabt
  • AArgentamo
  • AAri10blq
  • AASAASbqr
  • AAsdahs
  • AAsiaMilesajp
  • AAsianDatingayb
  • AAskablebpi
  • AAspirationaptn
  • Astra Otoshopafd
  • AstraPayaem
  • Astropaygr
  • AASVLAbuj
  • AAti Subhl
  • AAtlas Earthawq
  • AAtlasbusatb
  • AttaPollanl
  • AAUBANKdu
  • Auchanst
  • AAudibleaud
  • AAukroaox
  • AAuthentifyccy
  • AAuthor24kd
  • AAutodeskbbl
  • Autoruaej
  • AAv100proajl
  • AAvitoav
  • AVONff

Актуальное наличие и пример ответа:

GET https://api.smsactivate.uk/services
{
  "services": ["tg", "wa", "go"],
  "providers": { "source-counts": "per active catalog" },
  "generated_at": "ISO 8601 timestamp"
}

Каталог содержит названия и коды для поиска. Наличие актуально в реальном времени и может отличаться от этого списка; этот JSON показывает формат ответа, а не текущий инвентарь.

СтраныЧисловые ID стран из каталога кабинета. Общего endpoint API со списком стран для стандартных активаций нет.
Страна / числовой ID206 записей в каталоге
  • Afghanistan74
  • Albania155
  • Algeria58
  • Angola76
  • Anguilla181
  • Antigua and Barbuda169
  • Argentina39
  • Armenia148
  • Aruba179
  • Australia175
  • Austria50
  • Azerbaijan35
  • Bahamas122
  • Bahrain145
  • Bangladesh60
  • Barbados118
  • Belarus51
  • Belgium82
  • Belize124
  • Benin120
  • Bermuda195
  • Bhutan158
  • Bolivia92
  • Bosnia108
  • Botswana123
  • Brazil73
  • Brunei121
  • Bulgaria83
  • Burkina Faso152
  • Burundi119
  • Cambodia24
  • Cameroon41
  • Canada36
  • Cape Verde186
  • Cayman Islands170
  • Central African Republic125
  • Chad42
  • Chile151
  • China3
  • Colombia33
  • Comoros133
  • Congo150
  • Costa Rica93
  • Croatia45
  • Cuba113
  • Cyprus77
  • Czech63
  • Denmark172
  • Djibouti168
  • Dominica126
  • Dominican Republic109
  • DR Congo18
  • Ecuador105
  • Egypt21
  • Equatorial Guinea167
  • Eritrea176
  • Estonia34
  • Ethiopia71
  • Faroe Islands202
  • Fiji189
  • Finland163
  • France78
  • French Guiana162
  • Gabon154
  • Gambia28
  • Georgia128
  • Germany43
  • Ghana38
  • Gibraltar201
  • Greece129
  • Grenada127
  • Guadeloupe160
  • Guatemala94
  • Guinea68
  • Guinea-Bissau130
  • Guyana131
  • Haiti26
  • Honduras88
  • Hong Kong14
  • Hungary84
  • Iceland132
  • India22
  • Indonesia6
  • Iran57
  • Iraq47
  • Ireland23
  • Israel13
  • Italy86
  • Ivory Coast27
  • Jamaica103
  • Japan182
  • Jersey194
  • Jordan116
  • Kazakhstan2
  • Kenya8
  • Kosovo203
  • Kuwait100
  • Kyrgyzstan11
  • Laos25
  • Latvia49
  • Lebanon153
  • Lesotho136
  • Liberia135
  • Libya102
  • Liechtenstein200
  • Lithuania44
  • Luxembourg165
  • Macao20
  • Madagascar17
  • Malawi137
  • Malaysia7
  • Maldives159
  • Mali69
  • Malta199
  • Mauritania114
  • Mauritius157
  • Mexico54
  • Moldova85
  • Monaco144
  • Mongolia72

Формат ответа с предложениями для одного сервиса и страны:

[
  { "name": "any", "offers": [{ "price": 0.25, "count": 4 }] }
]

ID каталога определяют выбор страны, но не гарантируют актуальные предложения. Проверьте /offers/{service}/{country} для уточнения наличия.

GET/servicesПроверьте текущую доступность сервисов.

Открытый endpoint - API-ключ не нужен.

Параметры

Нет
Этот endpoint не принимает параметры запроса.

Пример запроса

curl https://api.smsactivate.uk/services

Ответ

Returns the current services array and generated_at timestamp. See the searchable Services catalog below for code/name lookup; it is a maintained reference, not a live availability guarantee.

Errors

Наличие может меняться. Проверьте актуальный endpoint и /offers/{service}/{country} перед заказом.

GET/countries/{service}Получите список ID стран, в которых сейчас есть номера для сервиса.

Открытый endpoint - API-ключ не нужен.

Параметры

service
Обязательный код сервиса, например tg.

Пример запроса

curl https://api.smsactivate.uk/countries/tg

Ответ

{ "countries": [2, 6, 187] }

Errors

ID стран совпадают с каталогом стран ниже. Наличие меняется; проверьте /offers/{service}/{country} перед заказом. Для этого endpoint действует ограничение частоты запросов.

GET/offers/{service}/{country}/deliveryПосмотрите недавние показатели доставки кодов по каждому ценовому уровню.

Открытый endpoint - API-ключ не нужен.

Параметры

service
Обязательный код сервиса, например tg.
country
Обязательный числовой ID страны.

Пример запроса

curl https://api.smsactivate.uk/offers/tg/2/delivery

Ответ

{
  "window_days": 30,
  "tiers": { "0.2500": { "orders": 120, "codes": 108, "delivery_pct": 90, "best": true } }
}

Errors

HTTP 400: неверный сервис или страна. Уровни без доставленных кодов не показываются. Результаты кэшируются примерно на 5 минут и охватывают последние window_days дней. Для этого endpoint действует ограничение частоты запросов.

GET/operators?service={service}&country={country}Получите список доступных операторов для сервиса и страны.

Открытый endpoint - API-ключ не нужен.

Параметры

service
Обязательный код сервиса, например tg.
country
Обязательный числовой ID страны.

Пример запроса

curl 'https://api.smsactivate.uk/operators?service=tg&country=2'

Ответ

[
  { "name": "any", "localName": "Any Operator" },
  { "name": "example", "localName": "Example operator" }
]

Errors

Список зависит от выбранной страны и текущего наличия. Нужны оба параметра, service и country; отсутствующие или неверные значения возвращают HTTP 422.

GET/offers/{service}/{country}Проверьте предложения для одной пары сервис и страна.

Открытый endpoint - API-ключ не нужен.

Параметры

service
Обязательное значение пути. Используйте код сервиса, возвращённый /services, например tg.
country
Обязательное значение пути. Числовой ID страны; для стандартных активаций используйте каталог стран в кабинете. Общего endpoint API со списком этих ID стран нет.

Пример запроса

curl https://api.smsactivate.uk/offers/tg/2

Ответ

[
  {
    "name": "any",
    "offers": [{ "price": "0.2500", "count": 4 }]
  }
]

Errors

Неподдерживаемая или недоступная пара может вернуть пустой список. Данные предложений кэшируются; при отсутствии в кэше ответ может идти дольше, пока проверяется наличие.

Просмотр прошлой активности

GET/ordersПросмотрите историю заказов, сначала новые.

Требуется API-ключ.

Параметры

page
Необязательный номер страницы; по умолчанию 1.
per_page
Необязательный размер страницы; по умолчанию 20, максимум 100.
status
Необязательно: active, completed (или received), cancelled, expired, refunded. Не указывайте или используйте all, чтобы включить все статусы.
search
Необязательный поиск по номеру телефона.
category
Необязательно: rents, links или numbers.

Пример запроса

curl 'https://api.smsactivate.uk/orders?page=2&per_page=100&status=received&category=numbers' -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "current_page": 2,
  "data": [{ "id": "ORDER_ID", "status": "received", "phone": "10000000000" }],
  "first_page_url": "…?page=1",
  "last_page": 4,
  "last_page_url": "…?page=4",
  "next_page_url": "…?page=3",
  "per_page": 100,
  "prev_page_url": "…?page=1",
  "total": 350
}

Errors

Переходите по next_page_url, пока значение не станет null. page по умолчанию 1; per_page по умолчанию 20, значения ограничены диапазоном 1–100. status принимает active, completed/received, cancelled, expired или refunded; all или неизвестное значение оставляет status без фильтра. search ищет по номерам телефонов. category принимает rents, links или numbers; неизвестные категории игнорируются. Для больших историй нужно несколько запросов страниц.

Аренда

GET/rent/servicesПроверьте сервисы аренды для страны и срока.

Требуется API-ключ.

Параметры

country
Необязательный целочисленный ID страны; по умолчанию 2.
duration
Необязательное число часов; по умолчанию 24. Допустимый диапазон: 24–1 344 часа.

Пример запроса

curl 'https://api.smsactivate.uk/rent/services?country=2&duration=24' -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns rental availability, with service codes and current prices for the selected country and duration.

Errors

HTTP 400: нет номера для аренды по выбранным параметрам. HTTP 422: неверная страна или срок. HTTP 503: каталог аренды временно недоступен.

POST/rent/orderСоздайте заказ аренды.

Требуется API-ключ.

Параметры

service
Обязательный код сервиса (строка).
country
Обязательный ID страны (целое число).
duration
Обязательное число часов, 24–1 344.
operator
Необязательная строка; по умолчанию any.

Пример запроса

curl -X POST https://api.smsactivate.uk/rent/order \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"service":"tg","country":2,"duration":24}'

Ответ

{
  "message": "Number rented successfully.",
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": 2.50,
  "balance_remaining": 7.50
}

Errors

HTTP 400: неверный запрос или недостаточно средств. HTTP 409: нет доступной аренды. HTTP 503: результат на проверке; не повторяйте, пока поддержка не проверит заказ.

POST/rent/cancel/{order_id}Запросите отмену подходящей аренды.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути. Тела запроса нет.

Пример запроса

curl -X POST https://api.smsactivate.uk/rent/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the cancellation result. Refunds may remain pending verification after cancellation is accepted.

Errors

Отмена возможна только для подходящей активной аренды через 2–20 минут после покупки и до получения SMS. HTTP 404: аренда не найдена. HTTP 409: аренда не подходит. Если отмена принята, возврат может ожидать проверки.

GET/rent/extend/{order_id}/optionsПроверьте доступные варианты продления аренды.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути аренды.

Пример запроса

curl https://api.smsactivate.uk/rent/extend/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "options": [{ "duration": 24, "price": 2.50 }],
  "expires_at": "2026-10-06T12:00:00Z"
}

Errors

HTTP 404: аренда не найдена. HTTP 409: аренда не подходит (продление открывается после первых 20 минут, аренда должна быть active или received, либо предыдущее продление находится на проверке). HTTP 503: продление временно недоступно или не удалось загрузить варианты; повторите позже. Для этого endpoint действует ограничение частоты запросов.

POST/rent/extend/{order_id}Продлите активную аренду.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути аренды.
duration
Обязательно: 24, 72, 168, 336, 720, 1 440, 2 160 или 4 320 часов. Выберите из текущего ответа с вариантами.
expected_price
Обязательное число, скопированное из текущего ответа с вариантами.
Idempotency-Key
Обязательный заголовок запроса UUID v4. Используйте его повторно только для безопасного повтора той же попытки продления.

Пример запроса

curl -X POST https://api.smsactivate.uk/rent/extend/ORDER_ID \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f6c1a52-8b1e-4c47-9d0a-6a1f2c9e7b10" \
  -d '{"duration":24,"expected_price":2.50}'

Ответ

{
  "message": "Rental extended successfully.",
  "attempt_id": "REQUEST_UUID",
  "status": "settled",
  "charged": 2.50,
  "new_expires_at": "2026-10-10T12:00:00Z",
  "balance_remaining": 7.50
}

Errors

HTTP 422: отсутствует или неверен duration, expected_price или Idempotency-Key. HTTP 409: аренда не подходит, срок или цена больше не предлагаются, либо Idempotency-Key уже использован. HTTP 202: продление на проверке; не повторяйте с новым ключом идемпотентности. HTTP 503: продление не удалось подтвердить; обратитесь в поддержку.

Верификация по почте

GET/emails/catalog?site={site}Получите список доменов адресов верификации, доступных для сайта.

Требуется API-ключ.

Параметры

site
Обязательный домен сайта, например example.com.

Пример запроса

curl 'https://api.smsactivate.uk/emails/catalog?site=example.com' -H "X-API-KEY: YOUR_API_KEY"

Ответ

[{ "name": "sample-domain.test", "price": 0.10, "stock": 5 }]

Errors

HTTP 422: неверное значение site. HTTP 503: почтовый каталог временно недоступен.

POST/emails/buyКупите один адрес верификации.

Требуется API-ключ.

Параметры

site
Обязательный домен сайта.
domain
Обязательный домен, выбранный из текущего ответа каталога.

Пример запроса

curl -X POST https://api.smsactivate.uk/emails/buy \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"site":"example.com","domain":"sample-domain.test"}'

Ответ

Returns an order object and balance_remaining when the purchase is confirmed.

Errors

HTTP 400: недостаточно средств в кошельке. HTTP 409: домен закончился. HTTP 503: покупка на проверке; не повторяйте, пока поддержка не проверит заказ.

POST/emails/{order_id}/reorderЗакажите тот же адрес снова после завершения предыдущего заказа.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути завершённого почтового заказа (число). Тела запроса нет.

Пример запроса

curl -X POST https://api.smsactivate.uk/emails/ORDER_ID/reorder -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the new email order, same shape as the email order response. The price is quoted at order time and charged from your balance.

Errors

HTTP 404: заказ не найден. HTTP 409: предыдущий заказ не завершён, повторный заказ уже выполняется или этот адрес сейчас нельзя заказать повторно. HTTP 503: почтовая верификация временно недоступна. Для этого endpoint действует ограничение частоты запросов.

GET/emails/historyПолучите список ваших заказов верификации по почте.

Требуется API-ключ.

Параметры

page
Необязательный номер страницы; по умолчанию 1.
per_page
Необязательный размер страницы; по умолчанию 20, максимум 50.

Пример запроса

curl 'https://api.smsactivate.uk/emails/history?page=1&per_page=20' -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns paginated order data and page metadata.

Errors

Если таблица почтовых заказов недоступна, API возвращает пустой массив data.

GET/emails/status/{order_id}Прочитайте или обновите заказ верификации.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути, возвращённое в ответе на покупку.

Пример запроса

curl https://api.smsactivate.uk/emails/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the order status and available verification result fields.

Errors

HTTP 404: заказ не найден. HTTP 503: статус не удалось обновить. В ответе только поля, доступные для заказа.

DELETE/emails/{order_id}Запросите отмену заказа верификации по почте.

Требуется API-ключ.

Параметры

order_id
Обязательное значение пути, возвращённое в ответе на покупку.

Пример запроса

curl -X DELETE https://api.smsactivate.uk/emails/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the cancellation result. The refund can remain pending verification.

Errors

Заказ должен принадлежать вашему аккаунту и подходить для отмены; текущее состояние заказа смотрите в сообщении об ошибке. Если в ответе сказано, что отмена ещё не подтверждена (HTTP 503), подождите пару минут и отправьте запрос снова.

Вебхуки

GET/webhookПрочитайте настройки вашего вебхука.

Требуется API-ключ.

Параметры

Нет
Параметров запроса нет.

Пример запроса

curl https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

Ответ

Returns the saved endpoint configuration. The signing secret is not returned by this read request.

Errors

Возвращает текущие настройки авторизованного аккаунта.

PUT/webhookСоздайте или обновите URL вебхука.

Требуется API-ключ.

Параметры

url
Обязательный публичный HTTPS URL на порту 443. Локальные и частные адреса отклоняются.

Пример запроса

curl -X PUT https://api.smsactivate.uk/webhook \
  -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/sms"}'

Ответ

Returns the saved configuration. On first setup the signing secret is returned once; store it safely.

Errors

HTTP 422: URL не является допустимым публичным HTTPS-адресом.

POST/webhook/rotate-secretЗамените секрет подписи настроенного вебхука.

Требуется API-ключ.

Параметры

Нет
Тела запроса нет. Сначала настройте вебхук.

Пример запроса

curl -X POST https://api.smsactivate.uk/webhook/rotate-secret -H "X-API-KEY: YOUR_API_KEY"

Ответ

{ "secret": "NEW_SECRET_SHOWN_ONCE" }

Errors

HTTP 404: вебхук не настроен. Сохраните новый секрет в надёжном месте; он возвращается в ответе на ротацию, а не endpoint чтения.

DELETE/webhookУдалите настройки вебхука.

Требуется API-ключ.

Параметры

Нет
Тела запроса нет.

Пример запроса

curl -X DELETE https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

Ответ

{ "configured": false }

Errors

Удаляет настройки вебхука авторизованного аккаунта.

POST/webhook/testОтправьте тестовое событие на настроенный endpoint.

Требуется API-ключ.

Параметры

Нет
Тела запроса нет. Сначала настройте вебхук.

Пример запроса

curl -X POST https://api.smsactivate.uk/webhook/test -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "delivered": true,
  "http_status": 200,
  "message": "Your server accepted the test message."
}

Errors

HTTP 404: вебхук не настроен. Тестовая доставка возвращает delivered=false, если ваш сервер её не принял.

GET/webhook/deliveriesПросмотрите до 50 последних попыток доставки вебхука.

Требуется API-ключ.

Параметры

Нет
Параметров запроса нет.

Пример запроса

curl https://api.smsactivate.uk/webhook/deliveries -H "X-API-KEY: YOUR_API_KEY"

Ответ

{
  "data": [{ "id": 42, "event_id": "EVENT_ID", "event_type": "sms.received", "status": "success", "attempts": 1, "http_status": 200 }]
}

Errors

Возвращает 50 последних HTTP-доставок вебхука, сначала новые.

POST/webhook/deliveries/{id}/retryПовторите одну из ваших доставок вебхука прямо сейчас.

Требуется API-ключ.

Параметры

id
Обязательное значение пути записи о доставке.

Пример запроса

curl -X POST https://api.smsactivate.uk/webhook/deliveries/42/retry -H "X-API-KEY: YOUR_API_KEY"

Ответ

{ "status": "success", "http_status": 200 }

Errors

HTTP 404: доставка не найдена. Для этого endpoint действует ограничение частоты запросов.

4. Оплата

Средства списываются с баланса при оформлении заказа. Активации, по которым не пришло ни одного SMS в течение 20-минутного окна, возвращаются на ваш баланс. Правила отмены и возврата различаются для аренды, электронной почты и API Links.

5. Отмена и возвраты

Для заказов номеров (активаций) можно запросить отмену после первых 2 минут и до окончания 20-минутного окна активации, только пока не пришло ни одного SMS. Подтверждённая отмена, отвечающая условиям, возвращает стоимость заказа на ваш баланс.

Активацию нельзя отменить после поступления SMS или после окончания её окна. Если подходящая активация не получает SMS в течение 20-минутного окна, стоимость заказа возвращается на ваш баланс.

Аренду можно отменить в том же окне от 2 до 20 минут, пока не пришёл код. Возврат за аренду ожидает проверки и не выполняется автоматически.

Номера оптом, API Links и заказы электронной почты не возвращаются после выдачи, если в панели не указано иное.

Если отмену не удаётся подтвердить, свяжитесь с поддержкой, прежде чем повторять попытку.

Frequently asked questions

How do I authenticate with the API?

Create or rotate a key in your dashboard. Send it in the X-API-KEY header with every request. The key is shown once when you create or rotate it. Keep it server-side. Open your dashboard.

What do I need for my first order?

A service code and a numeric country ID. Find them with GET /services and GET /countries/{service}, then check GET /offers/{service}/{country}. Prices are shown live in the dashboard. See live prices.

How do I read the code that arrives?

Poll GET /status/{order_id} and read sms_code when the status is received. GET /sms/{order_id} is rate-limited; do not use it for routine polling.

What if no SMS arrives?

An eligible activation with no SMS in its 20-minute window is refunded. You can also cancel an eligible active activation 2 to 20 minutes after purchase, before an SMS arrives. If a purchase response is uncertain, do not retry it; contact support. Read the FAQ.

Can I cancel an order?

For eligible active activations: POST /cancel/{order_id}, 2 to 20 minutes after purchase, before an SMS arrives. Rentals use POST /rent/cancel/{order_id}. API Links are final sale.

Does this API send verification codes to my users?

No. It receives codes on a number you order. If you need to send codes to your own users, this API is not the tool for that job.

How do webhooks work?

Set a public HTTPS URL on port 443 with PUT /webhook; the signing secret is returned once. Verify the signature as sha256= HMAC-SHA256 of "." and reject timestamps more than five minutes old. Test with POST /webhook/test.

Нужен более высокий лимит или индивидуальная интеграция? Свяжитесь с нашей командой. или откройте личный кабинет.