Public API - Orders

Create a new order (single service)

Creates a new activation order for a single service.

post/v1/public/orders/request-single-service

Request

  • Base URL: https://api.sms-virtual.net
  • URL: https://api.sms-virtual.net/v1/public/orders/request-single-service
  • Auth: API key in header x-api-key

Request body

serviceCountryPriceIdstring uuid required

Identifier of the chosen service-country price tier. Obtain it from GET /v1/services/list?countryId=… (each prices[] row exposes a serviceCountryPriceId) or from GET /v1/services/{serviceId}/countries.

operatorIdstring uuid

Optional operator constraint. Pass an id from GET /v1/operators to force a specific carrier; omit to let the system pick any operator.

quantitynumber

How many activations to create on this order. Defaults to 1. Each activation consumes one number from the pool and is billed independently.

autoSearchServerboolean

When the chosen price tier returns NO_NUMBERS / SERVER_ERROR, automatically retry against the next higher tier within the same service+country. Off by default to keep ordering deterministic.

autoSearchOperatorboolean

When the selected operator returns NO_NUMBERS, retry without operator filter (let provider pick any available operator). Requires a specific operatorId to be set; ignored when operatorId is "any".

Example request

{
  "serviceCountryPriceId": "a3093a46-2bad-428b-ac9f-2105940dc4d5",
  "operatorId": "0a23dc54-28af-4e15-bc09-5b73be22631d",
  "quantity": 1
}

Response

Order created successfully.

Changes

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