GET
/
phone_numbers
curl --request GET \
  --url https://api.voiceos.io/phone_numbers \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "uri": "<string>",
      "inbound_agent_id": "<string>",
      "phone_number": "<string>",
      "account_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "telephony": {
        "provider": "twilio",
        "phone_number_sid": "<string>",
        "account_sid": "<string>",
        "auth_token": "<string>"
      },
      "webhooks": [
        {
          "events": [
            "phone_call:connection_requested"
          ],
          "url": "<string>",
          "method": "GET",
          "headers": {},
          "filter": "<string>"
        }
      ],
      "id": "<string>"
    }
  ],
  "index": 123,
  "has_more": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

created_after
string

The date the phone number was created after.

created_before
string

The date the phone number was created before.

index
integer
default:1

The index of the page to return.

limit
integer
default:100

The number of phone numbers to return in the page.

Response

200
application/json
Successful Response
items
object[]
required

The list of phone numbers returned.

index
integer
required

The current index of the page.

has_more
boolean
required

Whether there is a next page.