Phone Numbers

Search Available Phone Numbers

Changed on

Search the purchasable number inventory. Buy an entry with POST /v1/agent/phone-numbers; availability is not a reservation, so a listed number can still be claimed by someone else first.

get/v1/agent/available-phone-numbers

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/v1/agent/available-phone-numbers
  • Auth
    HTTP bearer

Query parameters

country_codestring

ISO 3166-1 alpha-2 country code; US or CA.

area_codestring nullable

Restrict to one area code, e.g. 415.

number_type'local' | 'toll_free'

The managed inventory is US/CA local numbers only; toll_free currently returns 400.

provider'twilio' nullable

Inventory to search. Only the managed twilio inventory (call-transfer support) is available; the parameter is kept so importing your own numbers can extend it later.

Response

Request fulfilled, document follows

available_phone_numbersobject[] required

Inventory entries forwarded from the provider (number, region, pricing).

Changes