Sign in

v5

OpenAPI 3.1.02026-08-043621,4011.8 MB
Agents Platform

Get Phone Number

Retrieve Phone Number details by ID

get/v1/convai/phone-numbers/{phone_number_id}

Path parameters

phone_number_idstring required

The phone number ID. This is returned when a phone number is imported.

Example:TeaqRRdTcIfIu2i7BYfT

The phone number ID. This is returned when a phone number is imported.

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

OR
OR

Example response

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