Skip to content
clearance.rest

Overview

Rent or attach phone numbers and wait for the SMS they receive.

Numbers API 1.0.0

Section titled “Numbers API 1.0.0”

Three kinds of numbers share one surface:

  • Twilio: virtual numbers you rent and keep.

  • Hero SMS: temporary numbers rented for minutes, for one-off SMS verification.

  • Mobile: real SIM cards in Android phones, attached to your project by scanning a QR code with the SIM Bridge app.

Whichever kind a number is, GET /list, POST /release and GET /sms/wait work the same. Provider-specific actions live under /providers/{provider}/…. The provider is chosen by the path, never by a parameter.

Information

  • License: MIT
  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/list
POST
/release
GET
/sms/wait
GET
/providers/twilio/countries
GET
/providers/twilio/availables
POST
/providers/twilio/rent
GET
/providers/herosms/countries
GET
/providers/herosms/services
GET
/providers/herosms/operators
GET
/providers/herosms/prices
POST
/providers/herosms/rent
POST
/providers/herosms/resend
POST
/providers/mobile/claim/rest
POST
/providers/mobile/claim/ticket
GET
/providers/mobile/claim/socket
GET
/providers/mobile/download_apk

Authentication

Section titled “Authentication”

ApiKey

Section titled “ApiKey”

Your project’s API key (cr_live_…), shown on the project page in the console. Clients that cannot send headers may pass it as the api_key query parameter instead. A missing or invalid key returns 401.

Security scheme type: apiKey

Header parameter name: X-API-Key