Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Api's
  • Introduction
  • Get started
    • Quickstart
    • Authentication
  • Core concepts
    • Agents
    • Phone numbers
    • Calls
    • Webhooks
  • Webhooks
    • Overview
    • Assistant request
    • Tool calls
    • Status update
    • End of call report
    • Security
  • Guides
    • Campaigns
    • xAI Realtime Integration
    • Voice selection psychology
    • Analysis templates
    • BYOK Setup
    • Call analysis
    • Call Transfers
    • Custom Tools
    • Sip Trunks
    • Tool templates
    • Voicemail detection
    • Autonomous silence detection
    • Billing
    • Error codes
    • Rate limits
    • Troubleshooting
  • Api's
    • Campaigns
    • Agents
    • Voices
    • BYOK
    • Analysis templates
    • Tool templates
    • Organization
    • Phone numbers
    • Sip trunks
    • Calls
    • Call control
    • Usage
    • Domains
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Api's

Phone numbers

Manage phone numbers and their agent assignments.

Endpoints#

MethodEndpointDescription
GET/numbersList all phone numbers
POST/numbersRegister a phone number
GET/numbers/{id}Get a phone number
PATCH/numbers/{id}Update a phone number
DELETE/numbers/{id}Delete a phone number

List All Phone Numbers#

Retrieve all phone numbers in your account with their assigned agents and transfer trunks.
GET /numbers

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.
POST /numbers

Request Body#

FieldTypeRequiredDescription
phone_numberstringYesPhone number in E.164 format
namestringNoDisplay name
agent_idUUIDNoAgent to assign
transfer_trunk_idUUIDNoSIP 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#

StatusDescription
400Invalid phone number format
409Phone number already registered

Get a Phone Number#

Retrieve a specific phone number by ID.
GET /numbers/{id}

Parameters#

NameInTypeDescription
idpathUUIDPhone number UUID

Request#


Update a Phone Number#

Update agent assignment or transfer trunk for a phone number.
PATCH /numbers/{id}

Parameters#

NameInTypeDescription
idpathUUIDPhone number UUID

Request Body#

FieldTypeDescription
namestringDisplay name
agent_idUUIDAgent to assign (null to unassign)
transfer_trunk_idUUIDSIP trunk for transfers

Example: Change Agent#

Example: Unassign Agent#


Delete a Phone Number#

Remove a phone number from your account.
DELETE /numbers/{id}

Parameters#

NameInTypeDescription
idpathUUIDPhone number UUID

Request#

Response#

{
  "success": true
}
See PhoneNumber Schema for complete details.
Modified at 2026-01-30 12:19:12
Previous
Organization
Next
Sip trunks
Built with