# Request 1: Get campaign details
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: Get campaign details
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "campaign-uuid-1",
"name": "Sales Campaign",
"description": "Outbound sales campaign for Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/New_York",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Sales Agent",
"label": "Sales Agent Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+1234567890",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "call-uuid-2",
"to": "+1987654321",
"status": "failed",
"retries": 1,
"created_at": "2024-01-01T01:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
},
{
"id": "file-uuid-2",
"original_filename": "leads.xlsx",
"processed_filename": "processed_leads.csv",
"status": "processing",
"total_records": 500,
"processed_records": 0
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Calls & Campaigns
Get Campaign
Retrieve detailed information about a specific campaign including calls and files
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
# Request 1: Get campaign details
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: Get campaign details
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
{
"success": true,
"data": {
"id": "campaign-uuid-1",
"name": "Sales Campaign",
"description": "Outbound sales campaign for Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/New_York",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Sales Agent",
"label": "Sales Agent Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+1234567890",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "call-uuid-2",
"to": "+1987654321",
"status": "failed",
"retries": 1,
"created_at": "2024-01-01T01:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
},
{
"id": "file-uuid-2",
"original_filename": "leads.xlsx",
"processed_filename": "processed_leads.csv",
"status": "processing",
"total_records": 500,
"processed_records": 0
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Get Campaign
Retrieve detailed information about a specific campaign, including its configuration, associated calls, uploaded files, and performance statistics.Endpoint
GET /api/v1/campaigns/{campaign_id}
Path parameters
string
required
The unique identifier of the campaign.
Request headers
string
required
Bearer token for authentication. Format:
Bearer talq_your_environment_token_hereExample requests
# Request 1: Get campaign details
curl -X GET "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 1: Get campaign details
const response = await fetch('https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1', {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
# Request 2: Get campaign with specific ID
curl -X GET "https://app.talkover.ai/api/v1/campaigns/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer talq_your_environment_token_here"
// Request 2: Get campaign with specific ID
const campaign_id = '550e8400-e29b-41d4-a716-446655440000';
const response = await fetch(`https://app.talkover.ai/api/v1/campaigns/${campaign_id}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer talq_your_environment_token_here'
}
});
const result = await response.json();
console.log(result);
Response
Success Response (200 OK)
{
"success": true,
"data": {
"id": "campaign-uuid-1",
"name": "Sales Campaign",
"description": "Outbound sales campaign for Q1",
"status": "active",
"campaign_type": "sales",
"start_date": "2024-01-01",
"days_of_week": [1, 2, 3, 4, 5],
"earliest_call_time": "09:00:00",
"latest_call_time": "17:00:00",
"timezone": "America/New_York",
"agent_id": "agent-uuid-1",
"initial_call_delay": 0,
"max_retries": 3,
"retry_cooldown_hours": 24,
"enable_post_completion_cooldown": true,
"post_completion_cooldown_hours": 168,
"success_cooldown_hours": 168,
"voicemail_cooldown_hours": 24,
"no_answer_cooldown_hours": 24,
"busy_cooldown_hours": 24,
"failed_cooldown_hours": 24,
"do_not_call_enabled": true,
"do_not_call_list_source": "environment",
"auto_add_to_dnc_enabled": true,
"auto_dnc_trigger_statuses": ["completed", "voicemail"],
"auto_dnc_trigger_errors": ["invalid_number", "disconnected"],
"agent": {
"id": "agent-uuid-1",
"name": "Sales Agent",
"label": "Sales Agent Label"
},
"calls": [
{
"id": "call-uuid-1",
"to": "+1234567890",
"status": "completed",
"retries": 0,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": "call-uuid-2",
"to": "+1987654321",
"status": "failed",
"retries": 1,
"created_at": "2024-01-01T01:00:00Z"
}
],
"files": [
{
"id": "file-uuid-1",
"original_filename": "contacts.csv",
"processed_filename": "processed_contacts.csv",
"status": "processed",
"total_records": 1000,
"processed_records": 950
},
{
"id": "file-uuid-2",
"original_filename": "leads.xlsx",
"processed_filename": "processed_leads.csv",
"status": "processing",
"total_records": 500,
"processed_records": 0
}
],
"stats": {
"total_calls": 100,
"completed_calls": 80,
"failed_calls": 20,
"success_rate": 80.0,
"average_duration": 120
},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
}
}
Response fields
boolean
required
Indicates if the operation was successful.
object
required
Campaign details object.
Show Campaign Object
Show Campaign Object
string
required
Unique identifier for the campaign.
string
required
Name of the campaign.
string
Description of the campaign.
string
required
Current status of the campaign. Options:
draft, active, paused, completed, cancelled.string
required
Type of campaign. Options:
sales, follow_up, reminder, custom.string
required
Campaign start date (YYYY-MM-DD).
array
required
Array of days when calls can be made (1=Monday, 7=Sunday).
string
required
Earliest time to make calls (HH:MM:SS).
string
required
Latest time to make calls (HH:MM:SS).
string
required
Timezone for call scheduling.
string
required
UUID of the agent assigned to the campaign.
integer
required
Initial delay before making calls (seconds).
integer
required
Maximum number of retry attempts.
integer
required
Hours to wait between retry attempts.
boolean
required
Whether post-completion cooldown is enabled.
integer
required
Hours to wait after campaign completion.
integer
required
Hours to wait after successful calls.
integer
required
Hours to wait after voicemail calls.
integer
required
Hours to wait after no-answer calls.
integer
required
Hours to wait after busy calls.
integer
required
Hours to wait after failed calls.
boolean
required
Whether do-not-call list checking is enabled.
string
required
Source of do-not-call list. Options:
environment, campaign.boolean
required
Whether to automatically add numbers to do-not-call list.
array
required
Call statuses that trigger auto-add to DNC.
array
required
Call errors that trigger auto-add to DNC.
object
required
array
required
array
required
Array of files uploaded to this campaign.
Show File Object
Show File Object
string
required
Unique identifier for the file.
string
required
Original filename as uploaded.
string
required
Processed filename after conversion.
string
required
Processing status. Options:
uploading, processing, processed, failed.integer
required
Total number of records in the file.
integer
required
Number of records successfully processed.
object
required
string
required
ISO 8601 timestamp when the campaign was created.
string
required
ISO 8601 timestamp when the campaign was last updated.
Error responses
404 Not Found
{
"success": false,
"message": "Campaign not found"
}
401 Unauthorized
{
"success": false,
"message": "Unauthorized"
}
500 Server Error
{
"success": false,
"message": "Internal server error."
}
Error codes
| Code | Description | HTTP Status |
|---|---|---|
CAMPAIGN_NOT_FOUND | Specified campaign does not exist | 404 |
INVALID_TOKEN | Authentication token is invalid or missing | 401 |
SERVER_ERROR | Internal server error occurred | 500 |
Important notes
Complete data. This endpoint returns complete campaign information including calls, files, and statistics.
Real-time statistics. Campaign statistics are updated in real-time as calls are processed.
File processing status. Monitor file uploads and processing status through the files array.
Call history. View all calls associated with the campaign, including retry attempts.
Related endpoints
- List Campaigns:
GET /api/v1/campaigns - Create Campaign:
POST /api/v1/campaigns - Update Campaign:
PUT /api/v1/campaigns/{campaign_id} - Update Campaign Status:
PATCH /api/v1/campaigns/{campaign_id}/status - Delete Campaign:
DELETE /api/v1/campaigns/{campaign_id} - Make Campaign Call:
POST /api/v1/campaigns/{campaign_id}/call
Was this page helpful?