Guide du développeur

Documentation développeur

SMS Activate propose une API entièrement automatisée pour les utilisateurs qui ont besoin de louer des numéros de téléphone temporaires à grande échelle.

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.

Pour commencer

Créez une clé API dans votre tableau de bord, puis utilisez-la dans une requête côté serveur.

Ne placez jamais une clé API réelle dans du code de navigateur, des captures d'écran ou des dépôts publics.

Ouvrir les clés 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. Authentification

Récupérez votre clé API dans les paramètres de votre tableau de bord. Toutes les requêtes API doivent inclure l'en-tête suivant :

X-API-KEY: your_api_key_here

2. URL de base

Toutes les requêtes API utilisent cette URL de base :

https://api.smsactivate.uk

Exemple de requête

Cette requête passe une commande et peut débiter votre portefeuille. Remplacez le service et le pays d'exemple par une sélection disponible sur votre compte.

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}'

Référence de l'API

Chaque opération indique ses entrées, un exemple de requête, une réponse représentative et les principales erreurs. Les intégrations API existantes peuvent continuer à utiliser leurs anciens endpoints ; les endpoints par produit ci-dessous sont recommandés pour les nouvelles intégrations. Les exemples utilisent des ID et valeurs fictifs. Envoyez les requêtes authentifiées depuis votre serveur avec l'en-tête de clé API.

Pour commencer

GET/balanceConsultez le solde actuel de votre portefeuille.

Clé API requise.

Paramètres

Aucun
Aucun paramètre de requête.

Exemple de requête

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

Réponse

{ "balance": "10.0000" }

Errors

L'endpoint renvoie le solde actuel du compte authentifié.

Obtenir et gérer un numéro

POST/get_numbersPassez une commande d'activation.

Clé API requise.

Paramètres

service
Chaîne obligatoire. Code du service, par exemple tg.
country
Entier obligatoire. ID numérique du pays.
operator
Chaîne facultative. Par défaut : any.
max_price
Nombre facultatif. Prix maximum ; maxPrice est aussi accepté.
min_price
Nombre facultatif ; minPrice est aussi accepté.
any_price
Booléen facultatif ; anyPrice est aussi accepté.
product
Facultatif : standard (par défaut) ou api_links. Les API Links sont des achats d'inventaire en vente définitive.
idempotency_key
UUID facultatif pour les activations standard. Réutilisez la même clé uniquement pour la même demande d'achat lorsque son résultat est en cours de vérification.
quantity
Entier facultatif de 1 à 100 pour les commandes d'inventaire API Links ; 1 par défaut. Les commandes d'activation standard portent sur un seul numéro.

Exemple de requête

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}'

Réponse

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

Errors

HTTP 400 : sélection indisponible, limite de prix ou solde insuffisant. HTTP 409 : une commande précédente est encore en cours de vérification. HTTP 503 : échec temporaire ou commande incertaine ; si la réponse indique qu'un rapprochement est nécessaire, ne réessayez pas et contactez le support.

GET/sms/{order_id}Demandez une nouvelle vérification de l'état d'une commande active.

Clé API requise. Cet endpoint est soumis à une limite de débit.

Paramètres

order_id
Valeur de chemin obligatoire renvoyée lors de la création de la commande.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : la vérification des SMS n'est pas disponible pour cette commande. HTTP 404 : commande introuvable. HTTP 502 : échec temporaire de la vérification. Les commandes expirées renvoient leur état enregistré sans nouvelle vérification externe.

GET/status/{order_id}Consultez l'état d'une commande et les SMS reçus.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire renvoyée lors de la création de la commande.

Exemple de requête

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

Réponse

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

Errors

La réponse est limitée à la commande du compte authentifié. Si la recherche d'état échoue, l'API renvoie une erreur ; vérifiez l'ID de commande et réessayez plus tard si le service est temporairement indisponible.

POST/resend/{order_id}Demandez un autre SMS pour une activation active prise en charge.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire. Pas de corps de requête.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : renvoi non accepté ou commande expirée. HTTP 409 : le renvoi n'est pas disponible pour cette commande. HTTP 500 : le renvoi n'a pas pu être effectué.

POST/cancel/{order_id}Demandez l'annulation d'une activation éligible.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire. Pas de corps de requête.

Exemple de requête

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

Réponse

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

Errors

L'annulation n'est possible que pour les activations actives éligibles, de 2 à 20 minutes après l'achat et avant l'arrivée d'un SMS. Les locations utilisent /rent/cancel/{order_id} ; les API Links sont en vente définitive. Les annulations non éligibles ou non confirmées renvoient une erreur. Lisez la réponse d'annulation avant de réessayer.

GET/reactivate/{order_id}/optionsConsultez le prix et les détails actuels de la réactivation.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire de la commande d'origine.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : réactivation non prise en charge ou indisponible. HTTP 409 : la réactivation n'est pas disponible pour cette commande. HTTP 503 : aucun prix actuel valide n'a pu être confirmé.

POST/reactivate/{order_id}Réactivez une activation éligible au prix actuel.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire de la commande d'origine. Pas de corps de requête.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : réactivation non prise en charge ou solde du portefeuille insuffisant. HTTP 409 : non disponible pour cette commande. HTTP 503 : le résultat n'a pas pu être confirmé ; contactez le support avant de réessayer.

GET/orders/{order_id}Consultez les détails de l'une de vos commandes.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire renvoyée lors de la création de la commande.

Exemple de requête

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

Réponse

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 : commande introuvable ou n'appartenant pas à votre compte.

Choisir services, pays et prix

ServicesRecherchez dans le catalogue des services par nom ou code. La disponibilité peut changer ; consultez l'endpoint en direct avant de commander.
Nom / code1,638 entrées au catalogue
  • 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

Disponibilité en direct et exemple de réponse :

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

Le catalogue fournit des noms et des codes pour la recherche. La disponibilité est en direct et peut différer de cette liste ; ce JSON montre la forme de la réponse, pas l'inventaire actuel.

PaysID numériques de pays du catalogue du tableau de bord. Il n'existe pas d'endpoint général de liste des pays pour les activations standard.
Pays / ID numérique206 entrées au catalogue
  • 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

Forme de la réponse d'offres pour un service et un pays :

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

Les ID du catalogue identifient des choix de pays, sans garantie d'offres en direct. Consultez /offers/{service}/{country} pour connaître la disponibilité.

GET/servicesVérifiez la disponibilité actuelle des services.

Public - aucune clé API requise.

Paramètres

Aucun
Cet endpoint n'accepte aucun paramètre de requête.

Exemple de requête

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

Réponse

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

La disponibilité peut changer. Consultez l'endpoint en direct et /offers/{service}/{country} avant de commander.

GET/countries/{service}Listez les ID de pays qui ont actuellement des numéros pour un service.

Public - aucune clé API requise.

Paramètres

service
Code de service obligatoire, tel que tg.

Exemple de requête

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

Réponse

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

Errors

Les ID de pays correspondent au catalogue des pays ci-dessous. La disponibilité change ; consultez /offers/{service}/{country} avant de commander. Cet endpoint est soumis à une limite de débit.

GET/offers/{service}/{country}/deliveryConsultez les taux récents de livraison des codes pour chaque palier de prix.

Public - aucune clé API requise.

Paramètres

service
Code de service obligatoire, tel que tg.
country
ID numérique de pays obligatoire.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : service ou pays non valide. Les paliers sans code livré ne sont pas listés. Les résultats sont mis en cache environ 5 minutes et couvrent les window_days derniers jours. Cet endpoint est soumis à une limite de débit.

GET/operators?service={service}&country={country}Listez les opérateurs disponibles pour un service et un pays.

Public - aucune clé API requise.

Paramètres

service
Code de service obligatoire, tel que tg.
country
ID numérique de pays obligatoire.

Exemple de requête

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

Réponse

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

Errors

La liste dépend du pays sélectionné et de la disponibilité actuelle. service et country sont obligatoires ; des valeurs manquantes ou invalides renvoient HTTP 422.

GET/offers/{service}/{country}Consultez les offres pour une combinaison service et pays.

Public - aucune clé API requise.

Paramètres

service
Valeur de chemin obligatoire. Utilisez un code de service renvoyé par /services, tel que tg.
country
Valeur de chemin obligatoire. ID numérique de pays ; utilisez le catalogue des pays du tableau de bord pour les activations standard. Aucun endpoint général de l'API ne liste ces ID de pays.

Exemple de requête

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

Réponse

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

Errors

Une paire non prise en charge ou indisponible peut renvoyer une liste vide. Les données d'offres sont mises en cache ; un défaut de cache peut être plus lent pendant la vérification de la disponibilité.

Consulter l'activité passée

GET/ordersParcourez l'historique de vos commandes, de la plus récente à la plus ancienne.

Clé API requise.

Paramètres

page
Numéro de page facultatif ; 1 par défaut.
per_page
Taille de page facultative ; 20 par défaut, plafonnée à 100.
status
Facultatif : active, completed (ou received), cancelled, expired, refunded. Omettez-le ou utilisez all pour inclure tous les statuts.
search
Recherche facultative par numéro de téléphone.
category
Facultatif : rents, links ou numbers.

Exemple de requête

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

Réponse

{
  "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

Suivez next_page_url jusqu'à ce qu'il vaille null. page vaut 1 par défaut ; per_page vaut 20 par défaut et les valeurs sont limitées à 1–100. status accepte active, completed/received, cancelled, expired ou refunded ; all ou une valeur inconnue laisse status sans filtre. search recherche les numéros de téléphone. category accepte rents, links ou numbers ; les catégories inconnues sont ignorées. Les historiques volumineux nécessitent plusieurs requêtes de page.

Locations

GET/rent/servicesConsultez les services de location pour un pays et une durée.

Clé API requise.

Paramètres

country
ID de pays entier facultatif ; 2 par défaut.
duration
Heures facultatives ; 24 par défaut. Plage autorisée : 24–1 344 heures.

Exemple de requête

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

Réponse

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

Errors

HTTP 400 : aucun numéro de location disponible pour la sélection. HTTP 422 : pays ou durée non valide. HTTP 503 : catalogue de locations temporairement indisponible.

POST/rent/orderPassez une commande de location.

Clé API requise.

Paramètres

service
Code de service obligatoire (chaîne).
country
ID de pays obligatoire (entier).
duration
Heures obligatoires, de 24 à 1 344.
operator
Chaîne facultative ; par défaut any.

Exemple de requête

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}'

Réponse

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

Errors

HTTP 400 : requête non valide ou solde insuffisant. HTTP 409 : aucune location disponible. HTTP 503 : le résultat est en attente de vérification ; ne réessayez pas tant que le support n'a pas examiné la commande.

POST/rent/cancel/{order_id}Demandez l'annulation d'une location éligible.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire. Pas de corps de requête.

Exemple de requête

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

Réponse

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

Errors

L'annulation est limitée aux locations actives éligibles, de 2 à 20 minutes après l'achat et avant l'arrivée d'un SMS. HTTP 404 : location introuvable. HTTP 409 : la location n'est pas éligible. Si elle est acceptée, son remboursement peut rester en attente de vérification.

GET/rent/extend/{order_id}/optionsConsultez les options de prolongation disponibles pour une location.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire de la location.

Exemple de requête

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

Réponse

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

Errors

HTTP 404 : location introuvable. HTTP 409 : la location n'est pas éligible (la prolongation s'ouvre après les 20 premières minutes, la location doit être active ou received, ou une prolongation précédente est en attente de vérification). HTTP 503 : la prolongation est temporairement indisponible ou les options n'ont pas pu être chargées ; réessayez plus tard. Cet endpoint est soumis à une limite de débit.

POST/rent/extend/{order_id}Prolongez une location active.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire de la location.
duration
Obligatoire : 24, 72, 168, 336, 720, 1 440, 2 160 ou 4 320 heures. Choisissez dans la réponse actuelle des options.
expected_price
Nombre obligatoire copié depuis la réponse actuelle des options.
Idempotency-Key
En-tête de requête UUID v4 obligatoire. Réutilisez-le uniquement pour relancer sans risque la même tentative de prolongation.

Exemple de requête

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}'

Réponse

{
  "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 ou Idempotency-Key manquant ou non valide. HTTP 409 : la location n'est pas éligible, la durée ou le prix n'est plus proposé, ou l'Idempotency-Key a déjà été utilisée. HTTP 202 : la prolongation est en attente de vérification ; ne réessayez pas avec une nouvelle clé d'idempotence. HTTP 503 : la prolongation n'a pas pu être confirmée ; contactez le support.

Vérification par e-mail

GET/emails/catalog?site={site}Listez les domaines d'adresse de vérification disponibles pour un site.

Clé API requise.

Paramètres

site
Domaine de site web obligatoire, par exemple example.com.

Exemple de requête

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

Réponse

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

Errors

HTTP 422 : valeur de site non valide. HTTP 503 : catalogue e-mail temporairement indisponible.

POST/emails/buyAchetez une adresse de vérification.

Clé API requise.

Paramètres

site
Domaine de site web obligatoire.
domain
Domaine obligatoire choisi dans la réponse actuelle du catalogue.

Exemple de requête

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"}'

Réponse

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

Errors

HTTP 400 : solde du portefeuille insuffisant. HTTP 409 : domaine en rupture de stock. HTTP 503 : l'achat est en attente de vérification ; ne réessayez pas tant que le support n'a pas examiné la commande.

POST/emails/{order_id}/reorderRecommandez la même adresse une fois la commande précédente terminée.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire d'une commande e-mail terminée (numérique). Pas de corps de requête.

Exemple de requête

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

Réponse

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 : commande introuvable. HTTP 409 : la commande précédente n'est pas terminée, une recommande est déjà en cours ou cette adresse ne peut pas être recommandée maintenant. HTTP 503 : les vérifications par e-mail sont temporairement indisponibles. Cet endpoint est soumis à une limite de débit.

GET/emails/historyListez vos commandes de vérification par e-mail.

Clé API requise.

Paramètres

page
Numéro de page facultatif ; 1 par défaut.
per_page
Taille de page facultative ; 20 par défaut, plafonnée à 50.

Exemple de requête

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

Réponse

Returns paginated order data and page metadata.

Errors

Si la table des commandes e-mail n'est pas disponible, l'API renvoie un tableau data vide.

GET/emails/status/{order_id}Lisez ou actualisez une commande de vérification.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire renvoyée par la réponse d'achat.

Exemple de requête

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

Réponse

Returns the order status and available verification result fields.

Errors

HTTP 404 : commande introuvable. HTTP 503 : l'état n'a pas pu être actualisé. La réponse n'inclut que les champs disponibles pour la commande.

DELETE/emails/{order_id}Demandez l'annulation d'une commande de vérification par e-mail.

Clé API requise.

Paramètres

order_id
Valeur de chemin obligatoire renvoyée par la réponse d'achat.

Exemple de requête

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

Réponse

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

Errors

La commande doit appartenir à votre compte et être éligible à l'annulation ; consultez le message d'erreur renvoyé pour connaître l'état actuel de la commande. Si la réponse indique que l'annulation n'est pas encore confirmée (HTTP 503), patientez quelques minutes et renvoyez la requête.

Webhooks

GET/webhookLisez la configuration de votre webhook.

Clé API requise.

Paramètres

Aucun
Aucun paramètre de requête.

Exemple de requête

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

Réponse

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

Errors

Renvoie la configuration actuelle du compte authentifié.

PUT/webhookCréez ou mettez à jour l'URL de votre webhook.

Clé API requise.

Paramètres

url
URL HTTPS publique obligatoire sur le port 443. Les adresses locales et privées sont rejetées.

Exemple de requête

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"}'

Réponse

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

Errors

HTTP 422 : l'URL n'est pas une adresse HTTPS publique acceptée.

POST/webhook/rotate-secretRemplacez le secret de signature de votre webhook configuré.

Clé API requise.

Paramètres

Aucun
Pas de corps de requête. Configurez d'abord un webhook.

Exemple de requête

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

Réponse

{ "secret": "NEW_SECRET_SHOWN_ONCE" }

Errors

HTTP 404 : aucun webhook configuré. Conservez le nouveau secret en lieu sûr ; il est renvoyé par cette réponse de rotation, pas par l'endpoint de lecture.

DELETE/webhookSupprimez la configuration de votre webhook.

Clé API requise.

Paramètres

Aucun
Pas de corps de requête.

Exemple de requête

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

Réponse

{ "configured": false }

Errors

Supprime la configuration du webhook du compte authentifié.

POST/webhook/testEnvoyez un événement de test à votre endpoint configuré.

Clé API requise.

Paramètres

Aucun
Pas de corps de requête. Configurez d'abord un webhook.

Exemple de requête

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

Réponse

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

Errors

HTTP 404 : aucun webhook configuré. Une livraison de test indique delivered=false lorsque votre serveur ne l'accepte pas.

GET/webhook/deliveriesConsultez jusqu'à 50 tentatives récentes de livraison de webhook.

Clé API requise.

Paramètres

Aucun
Aucun paramètre de requête.

Exemple de requête

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

Réponse

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

Errors

Renvoie les 50 livraisons HTTP de webhook les plus récentes, de la plus récente à la plus ancienne.

POST/webhook/deliveries/{id}/retryRelancez maintenant l'une de vos livraisons de webhook.

Clé API requise.

Paramètres

id
Valeur de chemin obligatoire de l'enregistrement de livraison.

Exemple de requête

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

Réponse

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

Errors

HTTP 404 : livraison introuvable. Cet endpoint est soumis à une limite de débit.

4. Facturation

Votre solde est débité lorsque vous passez une commande. Les activations qui ne reçoivent aucun SMS dans la fenêtre de 20 minutes sont remboursées sur votre solde. Les règles d'annulation et de remboursement diffèrent pour les locations, les e-mails et les API Links.

5. Annulation et remboursements

Pour les commandes de numéros (activations), vous pouvez demander l'annulation après les 2 premières minutes et avant la fin de la fenêtre d'activation de 20 minutes, uniquement tant qu'aucun SMS n'est arrivé. Les annulations éligibles et confirmées restituent le montant de la commande sur votre solde.

Une activation ne peut plus être annulée dès qu'un SMS arrive ni après la fin de sa fenêtre. Si une activation éligible ne reçoit aucun SMS pendant sa fenêtre de 20 minutes, le montant de la commande est remboursé sur votre solde.

Les locations peuvent être annulées dans la même fenêtre de 2 à 20 minutes tant qu'aucun code n'est arrivé. Le remboursement d'une location est soumis à vérification et n'est pas automatique.

Les numéros en lot, les API Links et les commandes d'e-mails ne sont pas remboursables une fois livrés, sauf indication contraire dans le tableau de bord.

Si une annulation ne peut pas être confirmée, contactez le support avant de réessayer.

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.

Besoin d'une limite plus élevée ou d'une intégration personnalisée ? Contactez notre équipe. ou ouvrez votre tableau de bord.