1. Core concepts
  • HMS Sovereign API
  • Get started
    • Authentication
    • Introduction
    • Quickstart
  • Core concepts
    • Assistants
    • Calls
    • Phone Numbers
    • Webhooks
  • Platform
    • Billing & Credits
    • EU Data Sovereignty
    • Voice Selection
    • Whitelabel Portal
  • Webhooks
    • Assistant Request
    • End of Call Report
    • Webhooks Overview
    • Webhook Security
    • Status Update
    • Tool Calls
  • Configuration
    • Analysis Templates
    • Custom Tools
    • SIP Trunks
    • Tool Templates
  • Features
    • AI Generation
    • Autonomous Silence Handling
    • Call Analysis
    • Call Transfers
    • Campaigns Setup
    • Outbound Campaigns
    • Voicemail Detection
    • Web Calls
  • Integrations
    • BYOK Setup
    • Provider Pricing
    • xAI Grok Integration
  • Reference
    • Error Codes
    • Rate Limits
    • Troubleshooting
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Core concepts

Phone Numbers

Phone numbers are the entry point for your AI assistants. When a call comes in to a registered number, the assigned assistant handles the conversation.

How It Works#

1.
You configure a phone number with your SIP provider to forward calls to HMS Sovereign
2.
You register the number in HMS Sovereign via the API
3.
You assign an assistant to the number
4.
Incoming calls are automatically handled by the assigned assistant

Phone Number Properties#

PropertyTypeDescription
idUUIDUnique identifier
phone_numberstringPhone number in E.164 format (e.g., +31850835037)
namestringDisplay name for the number
assistant_idUUIDAssigned assistant (nullable)
transfer_trunk_idUUIDSIP trunk for call transfers (nullable)

Registering a Phone Number#

Response:
{
  "number": {
    "id": "abc12345-1234-5678-9012-abcdef123456",
    "phone_number": "+31850835037",
    "name": "Main Support Line",
    "assistant_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"
  }
}
See Register a Phone Number for details.

Updating Assistant Assignment#

Change which assistant handles calls for a number:
To unassign an assistant (calls will not be handled):
See Update a Phone Number for details.

Configuring Call Transfers#

To enable call transfers from this number, assign a SIP trunk:
See SIP Trunks for trunk configuration.

Listing All Numbers#

Response:
{
  "numbers": [
    {
      "id": "abc12345-...",
      "phone_number": "+31850835037",
      "name": "Main Support Line",
      "assistant_id": "17a0cb75-...",
      "transfer_trunk_id": null
    },
    {
      "id": "def67890-...",
      "phone_number": "+31201234567",
      "name": "Sales Line",
      "assistant_id": "28b1dc86-...",
      "transfer_trunk_id": "trunk-123-..."
    }
  ]
}
See List All Phone Numbers for details.

Deleting a Phone Number#

See Delete a Phone Number for details.

Related#

Assistants - Create assistants to assign to numbers
SIP Trunks - Configure trunks for call transfers
Calls - View call history for your numbers
Modified at 2026-03-17 10:59:50
Previous
Calls
Next
Webhooks
Built with