Sign in
Agents Platform

List Phone Numbers Page

Retrieve a page of Phone Numbers

get/v1/convai/v2/phone-numbers

Query parameters

page_sizeinteger

Number of phone numbers per page

Number of phone numbers per page

searchstring nullable

Filter by phone number ID, label, or phone number. A phone number ID must match exactly; label and phone number matching is a case-insensitive substring.

Filter by phone number ID, label, or phone number. A phone number ID must match exactly; label and phone number matching is a case-insensitive substring.

labelstring nullable

Filter by label. Matching is a case-insensitive substring.

Filter by label. Matching is a case-insensitive substring.

phone_numberstring nullable

Filter by phone number

Filter by phone number

provider'twilio' | 'sip_trunk' | 'exotel'

Filter by telephony provider

supports_outboundboolean nullable

Filter by whether the phone number can place outbound calls

Filter by whether the phone number can place outbound calls

agent_idstring nullable

Filter by assigned agent ID

Filter by assigned agent ID

branch_idstring nullable

Filter by assigned branch ID

Filter by assigned branch ID

sort_by'label' | 'phone_number'

The field to sort the results by

sort_direction'asc' | 'desc'

The direction to sort the results

cursorstring nullable

Used for fetching next page. Cursor is returned in the response.

Used for fetching next page. Cursor is returned in the response.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

next_cursorstring nullable

Pass this value as cursor to fetch the next page. Null when there are no more results.

has_moreboolean

Whether there are more results available

Example response

{
  "phone_numbers": [
    {
      "label": "Customer Support",
      "phone_number": "+1234567890",
      "phone_number_id": "phone_123",
      "provider": "twilio"
    }
  ]
}

Changes