Tekstiviestiaktivoinnin API

Kaksi tapaa: sms-activate-protokollan kanssa yhteensopiva rajapinta, jolloin nykyinen ohjelmisto vaihtaa muuttamalla URL-osoitteen ja avaimen, sekä JSON REST -API uusiin integraatioihin. Molemmat käyttävät samaa API-avainta paneelistasi.

Hanki API-avaimesi

Luo tili, avaa paneeli ja luo avain kohdassa API-käyttö. Pidä se salassa: kuka tahansa avaimen haltija voi käyttää saldoasi.

Rekisteröidy

Tyypillinen kulku

  1. Kutsu getNumber palvelulla ja maalla.
  2. Käytä numeroa kohdesovelluksessa.
  3. Kysy getStatus muutaman sekunnin välein, kunnes saat STATUS_OK.
  4. Kutsu setStatus arvolla 6 lopettaaksesi tai arvolla 8 peruuttaaksesi, jos koodia ei tullut.

sms-activate-yhteensopiva rajapinta

Lähetä GET- tai POST-pyyntöjä parametreilla api_key ja action. Vastaukset ovat pelkkää tekstiä, täsmälleen kuten sms-activatessa.

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

Toiminnot

ToimintoParametritVastaus
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-arvot

3
Pyydä uusi koodi samaan numeroon
6
Viimeistele aktivointi
8
Peruuta ja hyvitä (mahdollista kaksi minuuttia oston jälkeen)

JSON REST -API

Lähetä avain Authorization-otsakkeessa muodossa "Bearer KEY". Summat ovat merkkijonoja Yhdysvaltain dollareina neljällä desimaalilla.

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

Webhookit

Aseta URL paneelin kohdassa API-käyttö. Lähetämme jokaisesta tapahtumasta POST-pyynnön JSON-rungolla. Vastaa millä tahansa 2xx-tilalla 10 sekunnin kuluessa; muuten yritämme uudelleen 1, 5, 30, 120, 360 ja 720 minuutin kuluttua.

activation.sms_received
Ostamallesi numerolle saapui koodi.
activation.cancelled
Numero peruttiin tai vanheni, ja rahat palautettiin saldollesi.
rental.sms_received
Vuokratulle numerolle saapui tekstiviesti.
rental.ended
Vuokra päättyi tai peruttiin.

Esimerkkirunko

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

Allekirjoituksen tarkistus

Jokaisessa pyynnössä on X-Webhook-Signature-otsake muodossa t=1730000000,v1=…, jossa v1 on allekirjoitusavaimellasi laskettu heksadesimaalinen HMAC-SHA256 arvosta "t.body". Hylkää pyyntö, jos allekirjoitus ei täsmää tai t on yli 5 minuuttia vanha.

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));
}

Virheet

BAD_KEY
API-avain on väärä tai se on vaihdettu.
NO_NUMBERS
Tälle palvelulle ja maalle ei ole juuri nyt varastoa.
NO_BALANCE
Saldosi ei riitä tähän numeroon.
EARLY_CANCEL_DENIED
Peruutus on mahdollista kaksi minuuttia oston jälkeen.
NO_ACTIVATION
Aktivointitunnusta ei ole tai se ei ole sinun.