Purchase Cloud Numbers

Usage Instructions

Purchase cloud numbers.

Note: Available package durations vary by region. To ensure a successful purchase, please query the Cloud Number Purchase Package Details endpoint before purchasing to obtain the supported package durations for the selected region.

Request Instructions

Method: POST
Endpoint: /api/v1/cloudNumber/purchase

Request Parameters

Parameter	Type	Required	Description
region	string	Yes	Region code in ISO 3166-1 alpha-2 format. Examples: China = CN, United States = US, Russia = RU, Brazil = BR. A complete list of country codes can be found in the ISO 3166 country code standard.
duration	integer	Yes	Package duration to purchase. Since available durations vary by region, please query the Cloud Number Purchase Package Details endpoint to obtain the supported durations for the selected region before purchasing.
type	integer	No	Number type. 0 = VOIP (Virtual Number), 1 = Non-VOIP (Physical Number). Defaults to Non-VOIP if not specified.
quantity	integer	No	Quantity to purchase. Defaults to 1 if not specified.
coupon_code	string	No	Coupon code.
renewal_status	integer	No	Auto-renewal status. 0 = Disabled, 1 = Enabled. Defaults to 1.

Request Example

json Copy

{
    "region": "US",
    "duration": "30",
    "type": 1,
    "quantity": 2,
    "renewal_status": 1,
    "coupon_code": "xxxxxxx"
}

Response Example

json Copy

{
    "code": 200,
    "data": {
        "order_id": "xxxx"  // 	Order No
    },
    "message": "Success"
}

Cloud Number Purchase Package Details

Cloud Number Renewal Package Details

Last modified: 2026-06-10Powered by

Outline