Retrieve a paginated list of all phone numbers configured in your PIA Platform account

curl --request GET \
  --url https://api.example.com/v1/phone-numbers/

{
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "_id": "<string>",
      "provider": "sip",
      "friendly_name": "<string>",
      "sip_termination_uri": "<string>",
      "sip_trunk_username": "<string>",
      "sip_trunk_password": "<string>",
      "inbound_agent_id": "<string>",
      "outbound_agent_id": "<string>",
      "sip_infra_region": "global"
    }
  ],
  "next_page_token": "<string>"
}

Phone Numbers

Retrieve a paginated list of all phone numbers configured in your PIA Platform account

Retrieve a paginated list of all phone numbers configured in your PIA Platform account. The list includes all phone number types (Import Phone Numbers and PIA-managed) and their current configurations. Use the page_size and page_token parameters to navigate through the list for accounts with many phone numbers.

The response includes essential information for each phone number:

Phone number details and type
Associated AI agent (if any)
Configuration status
Creation and last modified timestamps

GET

phone-numbers

Retrieve a paginated list of all phone numbers configured in your PIA Platform account

curl --request GET \
  --url https://api.example.com/v1/phone-numbers/

{
  "phone_numbers": [
    {
      "phone_number": "<string>",
      "_id": "<string>",
      "provider": "sip",
      "friendly_name": "<string>",
      "sip_termination_uri": "<string>",
      "sip_trunk_username": "<string>",
      "sip_trunk_password": "<string>",
      "inbound_agent_id": "<string>",
      "outbound_agent_id": "<string>",
      "sip_infra_region": "global"
    }
  ],
  "next_page_token": "<string>"
}

Query Parameters

page_size

integer

default:20

Required range: 1 <= x <= 100

page_token

string | null

Response

Successful Response

phone_numbers

(GetSIPPhoneNumberResponse · object | GetPiaPhoneNumberResponse · object | GetTwilioPhoneNumberResponse · object)[]

required

List of phone number records matching the query parameters

GetSIPPhoneNumberResponse
GetPiaPhoneNumberResponse
GetTwilioPhoneNumberResponse

Show child attributes

next_page_token

string | null

Token for retrieving the next page of results. Null if there are no more results

Get Post Call Analysis Results Create a new phone number

⌘I