Register a phone number

Register a new phone number in your organization. The number must be configured with your SIP provider to forward calls to HMS Sovereign.

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Get your key from the dashboard.

In: header

application/json

TypeScript Definitions

Use the request body type in TypeScript.

phone_number*string

E.164 formatted phone number (required)

agent_id?string

Agent ID to assign to this number

Formatuuid

transfer_trunk_id?string

SIP trunk ID for call transfers

Formatuuid

is_active?boolean

Whether the number is active (default: true)

curl -X POST "https://example.com/numbers" \  -H "Content-Type: application/json" \  -d '{    "phone_number": "+31850835037"  }'

{
  "number": {
    "number": "+31850835037",
    "name": "HMS Sovereign Demo"
  }
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}

{
  "error": "Invalid API key",
  "message": "string"
}