Update phone number

curl --request PATCH \
  --url https://api.omnia-voice.com/api/v1/numbers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "friendlyName": "<string>",
  "agentId": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({friendlyName: '<string>', agentId: '<string>'})
};

fetch('https://api.omnia-voice.com/api/v1/numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.omnia-voice.com/api/v1/numbers/{id}"

payload = {
    "friendlyName": "<string>",
    "agentId": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "phoneNumber": "<string>",
  "friendlyName": "<string>",
  "agentId": "<string>",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "ACTIVE",
    "type": "standard",
    "workspaceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "standardConfig": {
      "languageId": "<string>",
      "voiceId": "<string>",
      "basePrompt": "<string>",
      "greeting": "<string>",
      "context": "<string>",
      "questions": "<string>",
      "customInstructions": "<string>",
      "recordingEnabled": true,
      "temperature": 0,
      "maxDuration": 3000,
      "firstSpeaker": "agent",
      "interruptible": false,
      "inactivityTimeout": 155,
      "inactivityAction": "hang_up",
      "model": "llama",
      "language": {
        "id": "<string>",
        "code": "<string>",
        "name": "<string>",
        "isActive": true
      },
      "voice": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "previewUrl": "<string>",
        "languageCode": "<string>",
        "gender": "<string>",
        "isActive": true,
        "language": {
          "code": "<string>",
          "name": "<string>"
        }
      }
    },
    "actions": [
      {}
    ],
    "knowledgeBases": [
      {}
    ]
  }
}

PATCH

numbers

{id}

Update phone number

curl --request PATCH \
  --url https://api.omnia-voice.com/api/v1/numbers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "friendlyName": "<string>",
  "agentId": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({friendlyName: '<string>', agentId: '<string>'})
};

fetch('https://api.omnia-voice.com/api/v1/numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.omnia-voice.com/api/v1/numbers/{id}"

payload = {
    "friendlyName": "<string>",
    "agentId": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "phoneNumber": "<string>",
  "friendlyName": "<string>",
  "agentId": "<string>",
  "status": "ACTIVE",
  "createdAt": "2023-11-07T05:31:56Z",
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "status": "ACTIVE",
    "type": "standard",
    "workspaceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "standardConfig": {
      "languageId": "<string>",
      "voiceId": "<string>",
      "basePrompt": "<string>",
      "greeting": "<string>",
      "context": "<string>",
      "questions": "<string>",
      "customInstructions": "<string>",
      "recordingEnabled": true,
      "temperature": 0,
      "maxDuration": 3000,
      "firstSpeaker": "agent",
      "interruptible": false,
      "inactivityTimeout": 155,
      "inactivityAction": "hang_up",
      "model": "llama",
      "language": {
        "id": "<string>",
        "code": "<string>",
        "name": "<string>",
        "isActive": true
      },
      "voice": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "previewUrl": "<string>",
        "languageCode": "<string>",
        "gender": "<string>",
        "isActive": true,
        "language": {
          "code": "<string>",
          "name": "<string>"
        }
      }
    },
    "actions": [
      {}
    ],
    "knowledgeBases": [
      {}
    ]
  }
}

Authorizations

X-API-Key

string

header

required

API key for authentication

Path Parameters

string

required

Body

application/json

friendlyName

string

agentId

string

status

enum<string>

Available options:

ACTIVE,

INACTIVE

Response

200 - application/json

Phone number updated successfully

string

Phone number assignment ID

phoneNumber

string

Phone number

friendlyName

string

Display name

agentId

string

Assigned agent ID

status

enum<string>

Available options:

ACTIVE,

INACTIVE

createdAt

string<date-time>

agent

object

An agent as returned by the API.

Note the asymmetry with the create/update payloads: you write configuration under config, and read it back under standardConfig (or customProvider). The type field tells you which one is present.

Show child attributes

Overview

Tools

Calls

Agents

Phone Numbers

Call Logs

Configuration

Pricing

Update phone number

Authorizations

Path Parameters

Body

Response