v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

List Phone Numbers

Retrieve all Phone Numbers

get/v1/convai/phone-numbers

Query parameters

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

Filter by telephony provider

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

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

Example response

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