SMS-aktiveerimise API

Kaks võimalust: sms-activate protokolliga ühilduv endpoint, et olemasolev tarkvara läheks üle URL-i ja võtme muutmisega, ning JSON REST API uute integratsioonide jaoks. Mõlemad kasutavad sinu paneeli sama API-võtit.

Hangi API-võti

Loo konto, ava paneel ja genereeri võti jaotises API ligipääs. Hoia see salajas: igaüks, kellel on võti, saab sinu saldot kulutada.

Registreeru

Tüüpiline voog

  1. Kutsu getNumber teenuse ja riigiga.
  2. Kasuta numbrit sihtrakenduses.
  3. Küsi getStatus iga paari sekundi järel, kuni saad STATUS_OK.
  4. Kutsu setStatus väärtusega 6 lõpetamiseks või 8 tühistamiseks, kui koodi ei tulnud.

sms-activate'iga ühilduv endpoint

Saada GET- või POST-päringuid parameetritega api_key ja action. Vastused on lihttekst, täpselt nagu sms-activate'is.

https://smsrota.com/stubs/handler_api.php?api_key=KEY&action=getNumber&service=wa&country=187

Toimingud

ToimingParameetridVastus
getBalance—ACCESS_BALANCE:12.5000
getPricesservice?, country?{"187":{"wa":{"cost":0.4,"count":1563}}}
getNumberservice, country, maxPrice?ACCESS_NUMBER:48151623:15550123456
getStatusidSTATUS_WAIT_CODE · STATUS_WAIT_RETRY:code · STATUS_OK:code · STATUS_CANCEL
setStatusid, statusACCESS_RETRY_GET · ACCESS_ACTIVATION · ACCESS_CANCEL
getRentNumberservice, country, rent_time (4/24/72/168/720){"status":"success","phone":{"id":31,"endDate":"…","number":"447700900001"}}
getRentStatusid{"status":"success","quantity":"1","values":{"0":{"phoneFrom":"WhatsApp","text":"…"}}}
setRentStatusid, status (1 = finish, 2 = cancel){"status":"success"}
continueRentNumberid, rent_time{"status":"success","phone":{…}}

setStatus väärtused

3
Küsi samale numbrile uus kood
6
Lõpeta aktiveerimine
8
Tühista ja maksa tagasi (võimalik kaks minutit pärast ostu)

JSON REST API

Saada võti Authorization-päises kujul "Bearer KEY". Summad on stringid USA dollarites nelja komakohaga.

GET   https://smsrota.com/v1/balance
GET   https://smsrota.com/v1/prices?service=wa
POST  https://smsrota.com/v1/activations  {"service":"wa","country":"187"}
GET   https://smsrota.com/v1/activations/:id
POST  https://smsrota.com/v1/activations/:id/retry
POST  https://smsrota.com/v1/activations/:id/complete
POST  https://smsrota.com/v1/activations/:id/cancel
GET   https://smsrota.com/v1/rent/prices?service=wa&hours=24
POST  https://smsrota.com/v1/rentals  {"service":"full","country":"16","hours":24}
GET   https://smsrota.com/v1/rentals/:id
POST  https://smsrota.com/v1/rentals/:id/extend  {"hours":24}
POST  https://smsrota.com/v1/rentals/:id/finish
POST  https://smsrota.com/v1/rentals/:id/cancel
POST  https://smsrota.com/v1/rentals/:id/dispute  {"reason":"no_sms"}
PUT   https://smsrota.com/v1/webhook  {"url":"https://example.com/sms-webhook"}
POST  https://smsrota.com/v1/webhook/test
GET   https://smsrota.com/v1/webhook/events

Veebihaagid

Määra URL oma paneeli jaotises API ligipääs. Iga sündmuse kohta saadame JSON-kehaga POST-päringu. Vasta 10 sekundi jooksul mis tahes 2xx olekuga; muidu proovime uuesti 1, 5, 30, 120, 360 ja 720 minuti pärast.

activation.sms_received
Ostetud numbrile saabus kood.
activation.cancelled
Number tühistati või aegus ja raha läks tagasi sinu saldole.
rental.sms_received
Renditud numbrile saabus SMS.
rental.ended
Rent lõppes või tühistati.

Näidiskeha

{
  "id": "evt_1042",
  "type": "activation.sms_received",
  "createdAt": "2026-11-01T10:00:00.000Z",
  "data": {
    "activationId": 48151623,
    "service": "wa",
    "country": "187",
    "phone": "15550123456",
    "code": "123456"
  }
}

Allkirja kontrollimine

Igal päringul on päis X-Webhook-Signature kujul t=1730000000,v1=…, kus v1 on "t.body" kuueteistkümnendsüsteemis HMAC-SHA256, mis on tehtud sinu allkirjastamise saladusega. Lükka päring tagasi, kui allkiri ei klapi või t on vanem kui 5 minutit.

import { createHmac, timingSafeEqual } from "node:crypto";

// rawBody: the request body exactly as received, before JSON parsing.
function verify(rawBody, header, secret) {
  const { t, v1 } = Object.fromEntries(header.split(",").map((p) => p.split("=")));
  const expected = createHmac("sha256", secret).update(`${t}.${rawBody}`).digest("hex");
  const fresh = Math.abs(Date.now() / 1000 - Number(t)) < 300;
  return fresh && v1.length === expected.length && timingSafeEqual(Buffer.from(v1), Buffer.from(expected));
}

Vead

BAD_KEY
API-võti on vale või on välja vahetatud.
NO_NUMBERS
Selle teenuse ja riigi jaoks pole praegu laoseisu.
NO_BALANCE
Sinu saldost ei piisa selle numbri jaoks.
EARLY_CANCEL_DENIED
Tühistada saab kaks minutit pärast ostu.
NO_ACTIVATION
Aktiveerimise ID-d pole olemas või see pole sinu oma.