Start Campaign (Number Pool)
curl --request POST \
--url https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"agent_id": "00000000-0000-4000-8000-0000000000a1",
"list_id": "123e4567-e89b-12d3-a456-426614174000",
"number_pool_id": "00000000-0000-4000-8000-0000000000b1"
}
'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start"
payload = {
"agent_id": "00000000-0000-4000-8000-0000000000a1",
"list_id": "123e4567-e89b-12d3-a456-426614174000",
"number_pool_id": "00000000-0000-4000-8000-0000000000b1"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '00000000-0000-4000-8000-0000000000a1',
list_id: '123e4567-e89b-12d3-a456-426614174000',
number_pool_id: '00000000-0000-4000-8000-0000000000b1'
})
};
fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "campaign registered successfully!",
"has_ongoing_calls": false
}{
"message": "Number pool not found."
}{
"message": "Invalid credentials"
}{
"message": "your current balance is insufficient to complete this action"
}{
"message": "An unexpected error occurred. Please try again later."
}Start Campaign (Number Pool)
Start a campaign uploaded with POST /campaign/save, taking caller numbers from a number pool that rotates numbers and skips ones flagged as spam.
POST
/
campaign
/
v2
/
start
Start Campaign (Number Pool)
curl --request POST \
--url https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"agent_id": "00000000-0000-4000-8000-0000000000a1",
"list_id": "123e4567-e89b-12d3-a456-426614174000",
"number_pool_id": "00000000-0000-4000-8000-0000000000b1"
}
'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start"
payload = {
"agent_id": "00000000-0000-4000-8000-0000000000a1",
"list_id": "123e4567-e89b-12d3-a456-426614174000",
"number_pool_id": "00000000-0000-4000-8000-0000000000b1"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agent_id: '00000000-0000-4000-8000-0000000000a1',
list_id: '123e4567-e89b-12d3-a456-426614174000',
number_pool_id: '00000000-0000-4000-8000-0000000000b1'
})
};
fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/v2/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "campaign registered successfully!",
"has_ongoing_calls": false
}{
"message": "Number pool not found."
}{
"message": "Invalid credentials"
}{
"message": "your current balance is insufficient to complete this action"
}{
"message": "An unexpected error occurred. Please try again later."
}list_id is the one returned by Upload campaign contact list; agent_id is the agent the list was uploaded for. Copy number_pool_id with Copy pool ID on the Number pools page (Number pools). email_completion_user_ids are workspace user IDs from List workspace users.
{
"agent_id": "your-agent-id",
"list_id": "123e4567-e89b-12d3-a456-426614174000",
"number_pool_id": "your-number-pool-id"
}
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Body
application/json
(Required) ID of the agent that will handle the calls.
Example:
"00000000-0000-4000-8000-0000000000a1"
(Required) ID of the uploaded campaign contact list.
Example:
"123e4567-e89b-12d3-a456-426614174000"
(Required) ID of the managed number pool to use for outbound calls.
Example:
"00000000-0000-4000-8000-0000000000b1"
User IDs to notify by email when the campaign completes.
Was this page helpful?