curl "https://api.ringyo.ai/v1/phone-numbers?status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/phone-numbers?status=active',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/phone-numbers',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'status': 'active'}
)
data = response.json()
phone_numbers = data['data']
{
"data": [
{
"id": "pn_abc123",
"phone_number": "+18005551234",
"friendly_name": "Main Business Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": true
},
"status": "active",
"default_agent_id": "agent_abc123",
"created_at": "2024-01-10T08:00:00Z"
},
{
"id": "pn_def456",
"phone_number": "+14155559876",
"friendly_name": "Sales Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": false
},
"status": "active",
"default_agent_id": null,
"created_at": "2024-01-12T10:30:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Phone Numbers
List Phone Numbers
List all phone numbers in your account
GET
/
v1
/
phone-numbers
curl "https://api.ringyo.ai/v1/phone-numbers?status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/phone-numbers?status=active',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/phone-numbers',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'status': 'active'}
)
data = response.json()
phone_numbers = data['data']
{
"data": [
{
"id": "pn_abc123",
"phone_number": "+18005551234",
"friendly_name": "Main Business Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": true
},
"status": "active",
"default_agent_id": "agent_abc123",
"created_at": "2024-01-10T08:00:00Z"
},
{
"id": "pn_def456",
"phone_number": "+14155559876",
"friendly_name": "Sales Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": false
},
"status": "active",
"default_agent_id": null,
"created_at": "2024-01-12T10:30:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Request
Retrieve a list of all phone numbers associated with your account.Headers
string
required
Bearer token for authentication. Format:
Bearer YOUR_API_KEYQuery Parameters
integer
default:"20"
Number of phone numbers to return (1-100)
string
Pagination cursor from a previous response
string
Filter by status:
active, pending, inactivestring
Filter by country code (e.g.,
US, GB, CA)Response
array
Array of phone number objects
boolean
Whether there are more results available
string
Cursor for fetching the next page
integer
Total number of phone numbers
curl "https://api.ringyo.ai/v1/phone-numbers?status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/phone-numbers?status=active',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const { data } = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/phone-numbers',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'status': 'active'}
)
data = response.json()
phone_numbers = data['data']
{
"data": [
{
"id": "pn_abc123",
"phone_number": "+18005551234",
"friendly_name": "Main Business Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": true
},
"status": "active",
"default_agent_id": "agent_abc123",
"created_at": "2024-01-10T08:00:00Z"
},
{
"id": "pn_def456",
"phone_number": "+14155559876",
"friendly_name": "Sales Line",
"country": "US",
"region": "CA",
"capabilities": {
"voice": true,
"sms": false
},
"status": "active",
"default_agent_id": null,
"created_at": "2024-01-12T10:30:00Z"
}
],
"has_more": false,
"next_cursor": null,
"total": 2
}
Phone Number Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier |
phone_number | string | E.164 formatted number |
friendly_name | string | Display name |
country | string | Two-letter country code |
region | string | State/region code |
capabilities | object | Voice and SMS capabilities |
status | string | active, pending, inactive |
default_agent_id | string | Agent for incoming calls |
created_at | string | ISO 8601 timestamp |
Error Codes
| Code | Description |
|---|---|
invalid_cursor | The pagination cursor is invalid |
invalid_country | Country code is not valid |
⌘I