Phone Numbers
Manage virtual phone numbers in your workspace. Phone numbers can be used for inbound/outbound calls, assigned to call flows, extensions, or SIP trunks.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /phone-numbers | List all phone numbers |
GET | /phone-numbers/:id | Get phone number details |
POST | /phone-numbers | Provision a new phone number |
PATCH | /phone-numbers/:id | Update phone number settings |
DELETE | /phone-numbers/:id | Release a phone number |
List Phone Numbers
GET /phone-numbers
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | number | Page number |
limit | number | Items per page |
search | string | Search by number or label |
Response
{
"data": [
{
"_id": "pn_abc123",
"number": "+84901234567",
"label": "Main Hotline",
"type": "local",
"status": "active",
"assignedTo": null,
"createdAt": "2026-01-15T08:30:00Z"
}
],
"total": 1,
"page": 1,
"limit": 20
}
info
Detailed request/response schemas will be added based on the API implementation.