Phone Extensions

4 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

`phone_extensions.list`

GET

List extensions configured on a given phone number.

AI tool: phone_extensions_list
API: GET /api/invoke/phone_extensions.list

Input

Field	Type	Required	Description
`phoneNumberId`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "phoneNumberId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "phoneNumberId"
  ]
}

`phone_extensions.create`

POST · mutating

Add an extension (IVR routing) on a phone number. e.g. press 1 → Sales (agent X), press 2 → Support (agent Y).

AI tool: phone_extensions_create
API: POST /api/invoke/phone_extensions.create

Input

Field	Type	Required
`phoneNumberId`	string	yes
`digits`	string	yes
`label`	string	yes
`description`	string	—
`assignedToActorId`	string	—
`forwardToNumber`	string	—
`voipEnabled`	boolean	—
`priority`	integer	—
`ivrPrompt`	string	—

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "phoneNumberId": {
      "type": "string",
      "minLength": 1
    },
    "digits": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "assignedToActorId": {
      "type": "string",
      "minLength": 1
    },
    "forwardToNumber": {
      "type": "string"
    },
    "voipEnabled": {
      "type": "boolean"
    },
    "priority": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "ivrPrompt": {
      "type": "string"
    }
  },
  "required": [
    "phoneNumberId",
    "digits",
    "label"
  ]
}

`phone_extensions.update`

PATCH · mutating

Update an extension.

AI tool: phone_extensions_update
API: PATCH /api/invoke/phone_extensions.update

Input

Field	Type	Required	Description
`id`	string	yes
`patch`	object	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    },
    "patch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "phoneNumberId": {
          "type": "string",
          "minLength": 1
        },
        "digits": {
          "type": "string"
        },
        "label": {
          "type": "string"
        },
        "description": {
          "default": "",
          "type": "string"
        },
        "assignedToActorId": {
          "anyOf": [
            {
              "type": "string",
              "minLength": 1
            },
            {
              "type": "null"
            }
          ]
        },
        "forwardToNumber": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "voipEnabled": {
          "default": false,
          "type": "boolean"
        },
        "priority": {
          "default": 0,
          "type": "integer",
          "minimum": -9007199254740991,
          "maximum": 9007199254740991
        },
        "ivrPrompt": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "active": {
          "default": true,
          "type": "boolean"
        },
        "createdAt": {},
        "updatedAt": {}
      }
    }
  },
  "required": [
    "id",
    "patch"
  ]
}

`phone_extensions.delete`

DELETE · mutating

Remove an extension.

AI tool: phone_extensions_delete
API: DELETE /api/invoke/phone_extensions.delete

Input

Field	Type	Required	Description
`id`	string	yes

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}