Orders

Create an order

Buy a number for one SMS verification. The price is debited from your balance on success. The order is live until expires_at; if no code arrives, a background job refunds it.

Also served as POST /api/v1/order.

post/api/v1/orders

Request

  • Base URL: https://virtualsms.io
  • URL: https://virtualsms.io/api/v1/orders
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Request body

servicestring required

Service id from GET /api/v1/services.

countrystring required

Country id from GET /api/v1/countries.

Example request

{
  "service": "telegram",
  "country": "US"
}

Response

Order created and number assigned

successboolean
order_idstring uuid
phone_numberstring
servicestring
service_idstring
service_namestring
countrystring
pricenumber float
statusstring
expires_atstring
created_atstring
can_swap_numberboolean

Changes

No recorded changes to this operation across all 1 revision of this API.