Manage phone numbers and their agent assignments.Endpoints#
List All Phone Numbers#
Retrieve all phone numbers in your account with their assigned agents and transfer trunks.Request#
Response#
{
"numbers": [
{
"id": "abc12345-1234-5678-9012-abcdef123456",
"phone_number": "+31850835037",
"name": "Main Support Line",
"agent_id": "17a0cb75-fa09-4bdd-9a44-92a70d829c88",
"transfer_trunk_id": null,
"created_at": "2025-12-13T10:00:00.000Z",
"updated_at": "2025-12-13T10:00:00.000Z"
}
]
}
Register a Phone Number#
Register a new phone number in your account. The number must be configured with your SIP provider to forward calls to Flireo.Request Body#
| Field | Type | Required | Description |
|---|
phone_number | string | Yes | Phone number in E.164 format |
name | string | No | Display name |
agent_id | UUID | No | Agent to assign |
transfer_trunk_id | UUID | No | SIP trunk for transfers |
Example Request#
Response (201 Created)#
{
"number": {
"id": "abc12345-1234-5678-9012-abcdef123456",
"phone_number": "+31850835037",
"name": "Main Support Line",
"agent_id": "17a0cb75-fa09-4bdd-9a44-92a70d829c88",
"transfer_trunk_id": null,
"created_at": "2025-12-13T10:00:00.000Z",
"updated_at": "2025-12-13T10:00:00.000Z"
}
}
Errors#
| Status | Description |
|---|
| 400 | Invalid phone number format |
| 409 | Phone number already registered |
Get a Phone Number#
Retrieve a specific phone number by ID.Parameters#
| Name | In | Type | Description |
|---|
id | path | UUID | Phone number UUID |
Request#
Update a Phone Number#
Update agent assignment or transfer trunk for a phone number.Parameters#
| Name | In | Type | Description |
|---|
id | path | UUID | Phone number UUID |
Request Body#
| Field | Type | Description |
|---|
name | string | Display name |
agent_id | UUID | Agent to assign (null to unassign) |
transfer_trunk_id | UUID | SIP trunk for transfers |
Example: Change Agent#
Example: Unassign Agent#
Delete a Phone Number#
Remove a phone number from your account.Parameters#
| Name | In | Type | Description |
|---|
id | path | UUID | Phone number UUID |
Request#
Response#
Modified at 2025-12-29 14:21:02
