Buy Numbers

Book a phone number, view your active numbers, and cancel orders.

Book a Number

POST /numbers/

Request Body

{
  "product": "mixin",
  "service_code": "tg",
  "country_code": 187,
  "period_code": 0
}

Parameters

Parameter	Required	Description
product	Yes	mixin or residential
service_code	Yes	From GET /numbers/mixed/
country_code	Yes	From GET /numbers/mixed/countries/
period_code	Residential only	From GET /numbers/residential/

Response

{
  "id": "640170a4-8188-468e-be5f-b2281170deed",
  "status": "waiting",
  "product": "mixin",
  "service_code": "tg",
  "country_code": "187",
  "phone_number": "13111111119",
  "last_sms_code": null,
  "expiration_time": "2023-08-31T14:21:20Z"
}

List Active Numbers

GET /numbers/

Returns all purchased numbers along with received SMS codes.

Response

[
  {
    "id": "640170a4-8188-468e-be5f-b2281170deed",
    "status": "waiting",
    "product": "mixin",
    "service_code": "tg",
    "country_code": "187",
    "phone_number": "13111111119",
    "last_sms_code": null,
    "expiration_time": "2023-08-31T14:21:20Z"
  }
]

Status Values

Status	Description
waiting	Number is active, waiting for an SMS
received	SMS code has been received
expired	Number has expired
cancelled	Number was cancelled

Cancel a Number

PUT /numbers/{id}/

Cancel or delete a purchased number by its ID.

Response

Returns 204 No Content on success.