Phone Numbers

List phone numbers

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/

List phone numbers for a workspace with pagination. Optionally filter by status. Requires PhoneNumber.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

limitinteger · max: 20OptionalDefault: 10

continuation_tokenintegerOptionalDefault: 0

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenany ofOptional

integerOptional

or

nullOptional

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

get

/v1/{workspace_id}/phone-numbers/

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/phone-numbers/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "workspace_id": "text",
      "phone_number": "text",
      "display_name": "text",
      "provider": "text",
      "capabilities": [
        "text"
      ],
      "status": "text",
      "inbound_service_id": "text",
      "provider_phone_sid": "text",
      "notes": "text",
      "forwarding": {
        "enabled": true,
        "forward_to": "text",
        "should_disconnect": true
      },
      "created_at": "2026-03-22T05:27:56.904Z",
      "updated_at": "2026-03-22T05:27:56.904Z"
    }
  ],
  "has_more": true,
  "continuation_token": 1
}

Create a phone number

post

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/

Register a new phone number in a workspace. Requires PhoneNumber.create permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Body

application/json

phone_numberstringRequired

display_namestringOptionalDefault: ""

providerstring · enumOptionalDefault: twilioPossible values:

capabilitiesstring[]OptionalDefault: ["inbound","outbound"]

statusstring · enumOptionalDefault: activePossible values:

inbound_service_idany ofOptional

string · uuidOptional

or

nullOptional

provider_phone_sidany ofOptional

stringOptional

or

nullOptional

notesstringOptionalDefault: ""

forwardingany ofOptional

or

nullOptional

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

409

Phone number already registered.

422

Invalid request body.

post

/v1/{workspace_id}/phone-numbers/

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/phone-numbers/ HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "phone_number": "text",
  "display_name": "",
  "provider": "twilio",
  "capabilities": [
    "text"
  ],
  "status": "active",
  "inbound_service_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_phone_sid": "text",
  "notes": "",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  }
}

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider": "text",
  "capabilities": [
    "text"
  ],
  "status": "text",
  "inbound_service_id": "text",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  },
  "created_at": "2026-03-22T05:27:56.904Z",
  "updated_at": "2026-03-22T05:27:56.904Z"
}

Get a phone number

get

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/{phone_number_id}

Retrieve a phone number by ID. Requires PhoneNumber.view permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

phone_number_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

phone_numberstringRequired

display_namestringRequired

providerstringRequired

capabilitiesstring[]Required

statusstringRequired

inbound_service_idany ofRequired

stringOptional

or

nullOptional

provider_phone_sidany ofRequired

stringOptional

or

nullOptional

notesstringRequired

forwardingany ofRequired

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Phone number not found.

422

Validation Error

application/json

get

/v1/{workspace_id}/phone-numbers/{phone_number_id}

HTTPcURLJavaScriptPython

GET /v1/{workspace_id}/phone-numbers/{phone_number_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider": "text",
  "capabilities": [
    "text"
  ],
  "status": "text",
  "inbound_service_id": "text",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  },
  "created_at": "2026-03-22T05:27:56.904Z",
  "updated_at": "2026-03-22T05:27:56.904Z"
}

Update a phone number

put

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/{phone_number_id}

Update a phone number's configuration. Requires PhoneNumber.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

phone_number_idstring · uuidRequired

Body

application/json

display_nameany ofOptional

stringOptional

or

nullOptional

providerany ofOptional

string · enumOptionalPossible values:

or

nullOptional

capabilitiesany ofOptional

string[]Optional

or

nullOptional

statusany ofOptional

string · enumOptionalPossible values:

or

nullOptional

inbound_service_idany ofOptional

string · uuidOptional

or

nullOptional

provider_phone_sidany ofOptional

stringOptional

or

nullOptional

notesany ofOptional

stringOptional

or

nullOptional

forwardingany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

phone_numberstringRequired

display_namestringRequired

providerstringRequired

capabilitiesstring[]Required

statusstringRequired

inbound_service_idany ofRequired

stringOptional

or

nullOptional

provider_phone_sidany ofRequired

stringOptional

or

nullOptional

notesstringRequired

forwardingany ofRequired

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Phone number not found.

422

Invalid request body.

put

/v1/{workspace_id}/phone-numbers/{phone_number_id}

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/phone-numbers/{phone_number_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "display_name": "text",
  "provider": "twilio",
  "capabilities": [
    "text"
  ],
  "status": "active",
  "inbound_service_id": "123e4567-e89b-12d3-a456-426614174000",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  }
}

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider": "text",
  "capabilities": [
    "text"
  ],
  "status": "text",
  "inbound_service_id": "text",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  },
  "created_at": "2026-03-22T05:27:56.904Z",
  "updated_at": "2026-03-22T05:27:56.904Z"
}

Delete a phone number

delete

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/{phone_number_id}

Delete a phone number. Requires PhoneNumber.delete permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

phone_number_idstring · uuidRequired

Responses

204

Successful Response

401

Missing or invalid API key.

403

Insufficient permissions.

404

Phone number not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/phone-numbers/{phone_number_id}

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/phone-numbers/{phone_number_id} HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Set call forwarding

put

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding

Configure call forwarding for a phone number. When enabled, the voice agent can transfer callers to the specified destination. Requires PhoneNumber.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

phone_number_idstring · uuidRequired

Body

application/json

Call forwarding configuration for create/update requests.

enabledbooleanOptionalDefault: true

forward_tostringRequired

should_disconnectbooleanOptionalDefault: true

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

phone_numberstringRequired

display_namestringRequired

providerstringRequired

capabilitiesstring[]Required

statusstringRequired

inbound_service_idany ofRequired

stringOptional

or

nullOptional

provider_phone_sidany ofRequired

stringOptional

or

nullOptional

notesstringRequired

forwardingany ofRequired

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Phone number not found.

422

Invalid forwarding config.

put

/v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding

HTTPcURLJavaScriptPython

PUT /v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "enabled": true,
  "forward_to": "text",
  "should_disconnect": true
}

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider": "text",
  "capabilities": [
    "text"
  ],
  "status": "text",
  "inbound_service_id": "text",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  },
  "created_at": "2026-03-22T05:27:56.904Z",
  "updated_at": "2026-03-22T05:27:56.904Z"
}

Clear call forwarding

delete

https://internal-api.platform.amigo.aihttps://api.platform.amigo.ai

/v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding

Remove call forwarding configuration from a phone number. Requires PhoneNumber.update permission.

Authorizations

BearerAuth

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

phone_number_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

phone_numberstringRequired

display_namestringRequired

providerstringRequired

capabilitiesstring[]Required

statusstringRequired

inbound_service_idany ofRequired

stringOptional

or

nullOptional

provider_phone_sidany ofRequired

stringOptional

or

nullOptional

notesstringRequired

forwardingany ofRequired

or

nullOptional

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Phone number not found.

422

Validation Error

application/json

delete

/v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding

HTTPcURLJavaScriptPython

DELETE /v1/{workspace_id}/phone-numbers/{phone_number_id}/forwarding HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider": "text",
  "capabilities": [
    "text"
  ],
  "status": "text",
  "inbound_service_id": "text",
  "provider_phone_sid": "text",
  "notes": "text",
  "forwarding": {
    "enabled": true,
    "forward_to": "text",
    "should_disconnect": true
  },
  "created_at": "2026-03-22T05:27:56.904Z",
  "updated_at": "2026-03-22T05:27:56.904Z"
}