API za aktivacijo SMS
Dve poti: endpoint, združljiv s protokolom sms-activate, da obstoječa programska oprema preklopi s spremembo URL-ja in ključa, ter JSON REST API za nove integracije. Oba uporabljata isti API ključ z vaše plošče.
Pridobite API ključ
Ustvarite račun, odprite ploščo in ustvarite ključ v razdelku Dostop do API. Hranite ga na skrivnem: kdorkoli ima ključ, lahko porablja vaše stanje.
RegistracijaTipičen potek
- Pokličite getNumber s storitvijo in državo.
- Uporabite številko v ciljni aplikaciji.
- Vsakih nekaj sekund preverjajte getStatus, dokler ne dobite STATUS_OK.
- Pokličite setStatus s 6 za zaključek ali z 8 za preklic, če koda ni prispela.
Endpoint, združljiv s sms-activate
Pošiljajte zahteve GET ali POST s parametroma api_key in action. Odgovori so navadno besedilo, natanko kot pri sms-activate.
https://smsrota.com/stubs/handler_api.php?api_key=KEY&action=getNumber&service=wa&country=187
Dejanja
| Dejanje | Parametri | Odgovor |
|---|---|---|
| getBalance | — | ACCESS_BALANCE:12.5000 |
| getPrices | service?, country? | {"187":{"wa":{"cost":0.4,"count":1563}}} |
| getNumber | service, country, maxPrice? | ACCESS_NUMBER:48151623:15550123456 |
| getStatus | id | STATUS_WAIT_CODE · STATUS_WAIT_RETRY:code · STATUS_OK:code · STATUS_CANCEL |
| setStatus | id, status | ACCESS_RETRY_GET · ACCESS_ACTIVATION · ACCESS_CANCEL |
| getRentNumber | service, country, rent_time (4/24/72/168/720) | {"status":"success","phone":{"id":31,"endDate":"…","number":"447700900001"}} |
| getRentStatus | id | {"status":"success","quantity":"1","values":{"0":{"phoneFrom":"WhatsApp","text":"…"}}} |
| setRentStatus | id, status (1 = finish, 2 = cancel) | {"status":"success"} |
| continueRentNumber | id, rent_time | {"status":"success","phone":{…}} |
Vrednosti setStatus
- 3
- Zahtevajte novo kodo na isto številko
- 6
- Zaključite aktivacijo
- 8
- Prekličite in vrnite (mogoče dve minuti po nakupu)
JSON REST API
Ključ pošljite v glavi Authorization kot "Bearer KEY". Zneski so nizi v ameriških dolarjih s štirimi decimalkami.
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/eventsSpletni kavlji
Nastavite URL v razdelku Dostop do API na svoji plošči. Za vsak dogodek pošljemo POST s telesom JSON. Odgovorite s katerim koli stanjem 2xx v 10 sekundah; sicer poskusimo znova po 1, 5, 30, 120, 360 in 720 minutah.
- activation.sms_received
- Za kupljeno številko je prispela koda.
- activation.cancelled
- Številka je bila preklicana ali je potekla in denar se je vrnil v vaše stanje.
- rental.sms_received
- Na najeto številko je prispel SMS.
- rental.ended
- Najem se je končal ali je bil preklican.
Primer telesa
{
"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"
}
}Preverjanje podpisa
Vsaka zahteva ima glavo X-Webhook-Signature v obliki t=1730000000,v1=…, kjer je v1 šestnajstiški HMAC-SHA256 iz "t.body", izračunan z vašo skrivnostjo za podpis. Zavrnite zahtevo, če se podpis ne ujema ali je t starejši od 5 minut.
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));
}Napake
- BAD_KEY
- API ključ je napačen ali je bil zamenjan.
- NO_NUMBERS
- Za to storitev in državo trenutno ni zaloge.
- NO_BALANCE
- Vaše stanje ne zadošča za to številko.
- EARLY_CANCEL_DENIED
- Preklic je mogoč dve minuti po nakupu.
- NO_ACTIVATION
- ID aktivacije ne obstaja ali ni vaš.