Skip to main content

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

MethodEndpointDescription
GET/phone-numbersList all phone numbers
GET/phone-numbers/:idGet phone number details
POST/phone-numbersProvision a new phone number
PATCH/phone-numbers/:idUpdate phone number settings
DELETE/phone-numbers/:idRelease a phone number

List Phone Numbers

GET /phone-numbers

Query Parameters

ParameterTypeDescription
pagenumberPage number
limitnumberItems per page
searchstringSearch 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.