Official PHP client for the SMSPool API: one-time SMS verification numbers, rentals, pre-orders, eSIMs and more.
Package: smspool/smspool-php on Packagist.
composer require smspool/smspool-phpGet your API key from your settings page.
$config = SMSPool\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_API_KEY');
$info = new SMSPool\Api\InformationApi(new GuzzleHttp\Client(), $config);
print_r($info->requestBalance());
$countries = $info->countryRetrieveAll();
$order = (new SMSPool\Api\SMSApi(new GuzzleHttp\Client(), $config))->purchaseSms('1', 'US');Errors (HTTP 4xx/5xx) throw SMSPool\ApiException, with getCode() and getResponseBody().
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.
- Generated reference for every method and parameter:
docs/ - 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(artifactVersion). - 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. There is no publish step: Packagist picks up new tags from GitHub by itself.
MIT