Cloud Number List

Usage Instructions

Get Cloud Number List, supports pagination, with a maximum of 100 items per page

Request Instructions

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

Request Parameters

Parameter	Type	Required	Description
phone_number	string	No	Phone Number
status	array	No	Status filter, 1 Active, 2 Expired
type_ids	array	No	Type：1 Non-VOIP, 2 VOIP
region_ids	array	No	Country filter, must comply with the ISO 3166-1 alpha-2 format. For example: China CN; United States US; Russia RU; Brazil BR, etc. A complete list of country codes can be obtained from the ISO 3166 Country Codes List
renewal_status	array	No	Renewal status, 1 Yes, 0 No
remark	string	No	Remark
sort_by	string	No	Sorting field. Options: created_at (Create Time); expired_at (Expiry Time)
order	string	No	Sorting order: asc for ascending, desc for descending
page	int	No	Request page number, defaults to the first page if not provided
pagesize	int	No	Number of items per page, defaults to 10 items/page if not provided

Response Parameters

Parameter	Type	Description
id	string	Cloud Number Id
phone_number	string	Phone Number, if empty, indicates that it is being generated
region_name	string	Region
type_name	string	Type
status_name	string	Status
renewal_status	integer	Auto Renewal, 0: No, 1: Yes
remark	string	Remark
created_at	string	Create Time（GMT+08:00）
expired_at	string	Expiry Time（GMT+08:00）

Request Example

json Copy

{
    "page": 1,
    "pagesize": 10,
    "sort_by": "created_at",
    "order": "asc",
    "phone_number": "xxxxxxxxx",
    "region_ids": ["US","GB"],
    "type_ids": [1,2],
    "status": [2],
    "renewal_status": [1,0],
    "remark": "xxx",
}

Response Example

json Copy

{
    "code": 200,
    "data": {
        "list": [
            {
                "id": "6XdPL", // Cloud Number Id
                "phone_number": "", // Phone Number, if empty, indicates that it is being generated.
                "region_name": "US", // Region Name
                "type_name": "VOIP", // Type Name
                "renewal_status": 0, // Auto Renewal, 0: No, 1: Yes
                "remark": "", // Remark
                "status_name": "Normal", // Status Name
                "expired_at": "2026-01-30 18:10:49" // Expiry Time
                "created_at": "2025-12-08 11:05:15",  // Create Time
            }
        ],
        "page": 1,
        "pagesize": 10,
        "total": 1,
        "total_page": 1
    },
    "message": "Success"
}

CloudNumber

Cloud Number SMS

Last modified: 2026-03-20Powered by

Outline