Twilio

Get Twilio sub-account

get

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

/v1/{workspace_id}/twilio/sub-account

Retrieve the Twilio sub-account for this workspace. Requires Workspace.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.

Responses

200

Successful Response

application/json

idstringRequired

workspace_idstringRequired

account_sidstringRequired

friendly_namestringRequired

environmentstringRequired

twiml_app_sidany ofRequired

stringOptional

or

nullOptional

statusstringRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

No sub-account provisioned.

get

/v1/{workspace_id}/twilio/sub-account

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "workspace_id": "text",
  "account_sid": "text",
  "friendly_name": "text",
  "environment": "text",
  "twiml_app_sid": "text",
  "status": "text",
  "created_at": "2026-03-22T05:27:57.082Z",
  "updated_at": "2026-03-22T05:27:57.082Z"
}

Provision Twilio sub-account

post

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

/v1/{workspace_id}/twilio/sub-account

Create a Twilio sub-account for this workspace with TwiML App. Idempotent — returns existing if already provisioned. Requires Workspace.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.

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

503

Twilio provisioning not configured.

post

/v1/{workspace_id}/twilio/sub-account

HTTPcURLJavaScriptPython

POST /v1/{workspace_id}/twilio/sub-account HTTP/1.1
Host: internal-api.platform.amigo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "workspace_id": "text",
  "account_sid": "text",
  "friendly_name": "text",
  "environment": "text",
  "twiml_app_sid": "text",
  "status": "text",
  "created_at": "2026-03-22T05:27:57.082Z",
  "updated_at": "2026-03-22T05:27:57.082Z"
}

Search available phone numbers

get

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

/v1/{workspace_id}/twilio/phone-numbers/available

Search available phone numbers for purchase on this workspace's Twilio sub-account. 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.

Query parameters

countrystringOptionalDefault: US

area_codeany ofOptional

stringOptional

or

nullOptional

containsany ofOptional

stringOptional

or

nullOptional

limitintegerOptionalDefault: 10

Responses

200

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

No sub-account provisioned.

422

Validation Error

application/json

get

/v1/{workspace_id}/twilio/phone-numbers/available

HTTPcURLJavaScriptPython

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

{
  "numbers": [
    {
      "phone_number": "text",
      "friendly_name": "text",
      "locality": "text",
      "region": "text",
      "capabilities": {
        "ANY_ADDITIONAL_PROPERTY": true
      }
    }
  ]
}

Purchase a phone number

post

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

/v1/{workspace_id}/twilio/phone-numbers/purchase

Purchase a phone number on this workspace's Twilio sub-account and register it. 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: ""

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

Responses

201

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

No sub-account provisioned.

409

Phone number already registered.

422

Validation Error

application/json

post

/v1/{workspace_id}/twilio/phone-numbers/purchase

HTTPcURLJavaScriptPython

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

{
  "phone_number": "text",
  "display_name": "",
  "capabilities": [
    "text"
  ]
}

{
  "id": "text",
  "workspace_id": "text",
  "phone_number": "text",
  "display_name": "text",
  "provider_phone_sid": "text",
  "status": "text",
  "capabilities": [
    "text"
  ],
  "created_at": "2026-03-22T05:27:57.082Z"
}

Release a phone number

delete

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

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

Release a phone number back to Twilio and remove from workspace. 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

No provider SID on number.

delete

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

HTTPcURLJavaScriptPython

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

No content