Official JavaScript / TypeScript client for the SMSPool API: one-time SMS verification numbers, rentals, pre-orders, eSIMs and more.
Package: @smspool/sdk on npm.
npm install @smspool/sdkGet your API key from your settings page.
import { Configuration, InformationApi, SMSApi } from "@smspool/sdk";
const config = new Configuration({ accessToken: "YOUR_API_KEY" });
console.log(await new InformationApi(config).requestBalance());
const countries = await new InformationApi(config).countryRetrieveAll();
const order = await new SMSApi(config).purchaseSms({ country: "US", service: "1" });Works in Node 18+ and browsers (it uses fetch). Errors (HTTP 4xx/5xx) throw a
ResponseError; e.response is the Response.
Every endpoint in the API reference is a method named after
its path, on the class for its section: /sms/check is smsCheck() on SMSApi. Endpoints that need
your API key send it as a bearer token.
Responses are returned as decoded JSON exactly as the API sends them: many endpoints answer
200 with "success": 0 and a message when a request is refused, so check success.
- API reference with examples: https://api.smspool.net/docs
The code is generated from the API's OpenAPI spec
(openapi.json) with
OpenAPI Generator. Do not edit generated files by hand:
a workflow regenerates them every week and opens a pull request when the API changed.
Hand-written files are listed in .openapi-generator-ignore.
- Set the new version in
openapi-generator.yaml(npmVersion). - Run
scripts/generate.sh(needs Docker) andscripts/smoke.sh, then commit. - Tag and push:
git tag vX.Y.Z && git push origin vX.Y.Z.
The Release workflow checks the tag against the version, runs the smoke test and publishes.
Publishing needs the NPM_TOKEN secret (an npm granular access token with publish access to the @smspool scope).
MIT