Phone Numbers

Manage phone number assignments

List phone numbers

get

Retrieve a list of phone number assignments

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

pageintegerOptionalDefault: 1

limitintegerOptionalDefault: 50

statusstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

get

/numbers

HTTPcURLJavaScriptPython

GET /api/v1/numbers HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "data": [
    {
      "id": "text",
      "phoneNumber": "text",
      "friendlyName": "text",
      "agentId": "text",
      "status": "ACTIVE",
      "createdAt": "2026-02-08T10:05:43.921Z",
      "agent": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "createdAt": "2026-02-08T10:05:43.921Z",
        "updatedAt": "2026-02-08T10:05:43.921Z",
        "config": {
          "languageId": "text",
          "voiceId": "text",
          "greeting": "text",
          "basePrompt": "text",
          "context": "text",
          "questions": "text",
          "customInstructions": "text",
          "recordingEnabled": true,
          "temperature": 1,
          "maxDuration": 1,
          "firstSpeaker": "agent",
          "interruptible": true,
          "inactivityTimeout": 1,
          "inactivityAction": "hang_up",
          "language": {
            "id": "text",
            "code": "text",
            "name": "text",
            "isActive": true
          },
          "voice": {
            "id": "text",
            "name": "text",
            "description": "text",
            "previewUrl": "text",
            "languageCode": "text"
          }
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  }
}

Assign phone number

post

Create a phone number assignment

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Body

application/json

phoneNumberstringRequired

Phone number to assign

friendlyNamestringOptional

Display name

agentIdstringRequired

Agent to assign to

Responses

201

Phone number assigned successfully

application/json

post

/numbers

HTTPcURLJavaScriptPython

POST /api/v1/numbers HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "phoneNumber": "text",
  "friendlyName": "text",
  "agentId": "text"
}

201

Phone number assigned successfully

{
  "id": "text",
  "phoneNumber": "text",
  "friendlyName": "text",
  "agentId": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:05:43.921Z",
  "agent": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "createdAt": "2026-02-08T10:05:43.921Z",
    "updatedAt": "2026-02-08T10:05:43.921Z",
    "config": {
      "languageId": "text",
      "voiceId": "text",
      "greeting": "text",
      "basePrompt": "text",
      "context": "text",
      "questions": "text",
      "customInstructions": "text",
      "recordingEnabled": true,
      "temperature": 1,
      "maxDuration": 1,
      "firstSpeaker": "agent",
      "interruptible": true,
      "inactivityTimeout": 1,
      "inactivityAction": "hang_up",
      "language": {
        "id": "text",
        "code": "text",
        "name": "text",
        "isActive": true
      },
      "voice": {
        "id": "text",
        "name": "text",
        "description": "text",
        "previewUrl": "text",
        "languageCode": "text"
      }
    }
  }
}

Get phone number

get

Retrieve a specific phone number assignment

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

200

Successful response

application/json

get

/numbers/{id}

HTTPcURLJavaScriptPython

GET /api/v1/numbers/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "id": "text",
  "phoneNumber": "text",
  "friendlyName": "text",
  "agentId": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:05:43.921Z",
  "agent": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "createdAt": "2026-02-08T10:05:43.921Z",
    "updatedAt": "2026-02-08T10:05:43.921Z",
    "config": {
      "languageId": "text",
      "voiceId": "text",
      "greeting": "text",
      "basePrompt": "text",
      "context": "text",
      "questions": "text",
      "customInstructions": "text",
      "recordingEnabled": true,
      "temperature": 1,
      "maxDuration": 1,
      "firstSpeaker": "agent",
      "interruptible": true,
      "inactivityTimeout": 1,
      "inactivityAction": "hang_up",
      "language": {
        "id": "text",
        "code": "text",
        "name": "text",
        "isActive": true
      },
      "voice": {
        "id": "text",
        "name": "text",
        "description": "text",
        "previewUrl": "text",
        "languageCode": "text"
      }
    }
  }
}

Update phone number

put

Update a phone number assignment

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Body

application/json

friendlyNamestringOptional

agentIdstringOptional

statusstring · enumOptionalPossible values:

Responses

200

Phone number updated successfully

application/json

put

/numbers/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/numbers/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "friendlyName": "text",
  "agentId": "text",
  "status": "ACTIVE"
}

200

Phone number updated successfully

{
  "id": "text",
  "phoneNumber": "text",
  "friendlyName": "text",
  "agentId": "text",
  "status": "ACTIVE",
  "createdAt": "2026-02-08T10:05:43.921Z",
  "agent": {
    "id": "text",
    "name": "text",
    "description": "text",
    "status": "ACTIVE",
    "createdAt": "2026-02-08T10:05:43.921Z",
    "updatedAt": "2026-02-08T10:05:43.921Z",
    "config": {
      "languageId": "text",
      "voiceId": "text",
      "greeting": "text",
      "basePrompt": "text",
      "context": "text",
      "questions": "text",
      "customInstructions": "text",
      "recordingEnabled": true,
      "temperature": 1,
      "maxDuration": 1,
      "firstSpeaker": "agent",
      "interruptible": true,
      "inactivityTimeout": 1,
      "inactivityAction": "hang_up",
      "language": {
        "id": "text",
        "code": "text",
        "name": "text",
        "isActive": true
      },
      "voice": {
        "id": "text",
        "name": "text",
        "description": "text",
        "previewUrl": "text",
        "languageCode": "text"
      }
    }
  }
}

Delete phone number

delete

Delete a phone number assignment

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Responses

200

Phone number deleted successfully

No content

delete

/numbers/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/numbers/{id} HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

200

Phone number deleted successfully

No content

Get agent phone numbers

get

Get all phone numbers assigned to an agent

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Path parameters

idstringRequired

Agent ID

Responses

200

Successful response

application/json

get

/agents/{id}/numbers

HTTPcURLJavaScriptPython

GET /api/v1/agents/{id}/numbers HTTP/1.1
Host: dashboard.omnia-voice.com
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "data": [
    {
      "id": "text",
      "phoneNumber": "text",
      "friendlyName": "text",
      "agentId": "text",
      "status": "ACTIVE",
      "createdAt": "2026-02-08T10:05:43.921Z",
      "agent": {
        "id": "text",
        "name": "text",
        "description": "text",
        "status": "ACTIVE",
        "createdAt": "2026-02-08T10:05:43.921Z",
        "updatedAt": "2026-02-08T10:05:43.921Z",
        "config": {
          "languageId": "text",
          "voiceId": "text",
          "greeting": "text",
          "basePrompt": "text",
          "context": "text",
          "questions": "text",
          "customInstructions": "text",
          "recordingEnabled": true,
          "temperature": 1,
          "maxDuration": 1,
          "firstSpeaker": "agent",
          "interruptible": true,
          "inactivityTimeout": 1,
          "inactivityAction": "hang_up",
          "language": {
            "id": "text",
            "code": "text",
            "name": "text",
            "isActive": true
          },
          "voice": {
            "id": "text",
            "name": "text",
            "description": "text",
            "previewUrl": "text",
            "languageCode": "text"
          }
        }
      }
    }
  ]
}