Get Workspace Numbers
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/numbers \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/numbers"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_numbers": [
{
"id": "00000000-0000-4000-8000-000000000109",
"number": "+919876540001",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"call_count": 0,
"agent": {
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "Sales Assistant"
},
"is_inbound_enabled": true,
"is_test_number": false,
"is_relay": false,
"tags": [],
"is_spam": false,
"spam_message": null,
"provider": "ringg",
"display_name": "Sales Line",
"owner": "ringg",
"is_custom_number": false,
"telephony_id": "00000000-0000-4000-8000-000000000113",
"number_pool_id": "00000000-0000-4000-8000-000000000113"
}
]
}{
"message": "Invalid telephony_account_id: abc"
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Get Workspace Numbers
List the phone numbers in your workspace with their IDs, provider, attached agent, spam flag and pool, to choose the caller number for calls and campaigns.
GET
/
workspace
/
numbers
Get Workspace Numbers
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/workspace/numbers \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/workspace/numbers"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/workspace/numbers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"workspace_numbers": [
{
"id": "00000000-0000-4000-8000-000000000109",
"number": "+919876540001",
"created_at": "2024-12-16T13:03:29.947147+00:00",
"call_count": 0,
"agent": {
"id": "00000000-0000-4000-8000-0000000000a1",
"agent_display_name": "Sales Assistant"
},
"is_inbound_enabled": true,
"is_test_number": false,
"is_relay": false,
"tags": [],
"is_spam": false,
"spam_message": null,
"provider": "ringg",
"display_name": "Sales Line",
"owner": "ringg",
"is_custom_number": false,
"telephony_id": "00000000-0000-4000-8000-000000000113",
"number_pool_id": "00000000-0000-4000-8000-000000000113"
}
]
}{
"message": "Invalid telephony_account_id: abc"
}{
"message": "Invalid credentials"
}{
"message": "An unexpected error occurred. Please try again later."
}Each number’s
id is the from_number_id that individual calls take as caller ID.
Numbers appear here once they are bought or imported in the dashboard (Buy and import numbers).
The list is not paged: every matching number comes back in one response, newest first. Filter it with telephony_account_id (a connected telephony account’s ID, or ringg for numbers provided by Ringg, including the shared test numbers) and inbound_enabled (true or false).
Fields to check
object
The agent the number is attached to (
id, agent_display_name); inbound calls to the number reach that agent.boolean
A shared Ringg test number: for testing only, not for live calls or number pools.
boolean
The number has been flagged as spam;
spam_message says why. Pick another number, or let a number pool skip it.string
The number pool the number belongs to, if any.
string
The telephony provider behind the number;
ringg for numbers on Ringg’s own account.string
ringg for a number on Ringg’s account, customer for one on your own telephony account.boolean
true for a WhatsApp Relay number.Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
(Optional) A connected telephony account's ID to list only its numbers, or ringg for numbers provided by Ringg, including the shared test numbers. Leave it out for every number.
Example:
"ringg"
(Optional) true for numbers that can receive inbound calls, false for the rest.
Response
Successful Response: A list of available phone numbers.
Show child attributes
Show child attributes
Was this page helpful?