Get campaign status
curl --request GET \
--url https://api.osvi.ai/v1/campaigns/{id}/status \
--header 'API-Token: <api-key>'import requests
url = "https://api.osvi.ai/v1/campaigns/{id}/status"
headers = {"API-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Token': '<api-key>'}};
fetch('https://api.osvi.ai/v1/campaigns/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.osvi.ai/v1/campaigns/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.osvi.ai/v1/campaigns/{id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.osvi.ai/v1/campaigns/{id}/status")
.header("API-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.osvi.ai/v1/campaigns/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaign": {
"id": 7,
"name": "June Renewals",
"status": "active",
"is_retry_enabled": true,
"retry_threshold": 2,
"retry_delay": 1800,
"created_at": "2026-06-01T10:00:00+05:30"
},
"calls": {
"total": 120,
"by_status": {
"picked": 88,
"not_picked": 25,
"failed": 7
}
},
"uploads": [
{
"campaign_upload_id": 19,
"file_name": "1718000000-api_contacts_ab12cd34ef567890.csv",
"agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
"created_at": "2026-06-02T11:00:00+05:30",
"queues": [
{
"agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
"total_queued": 50,
"completed": false
}
]
}
]
}
}{
"success": false,
"error": "Invalid API token"
}{
"success": false,
"error": "Campaign not found",
"details": null
}Campaigns
Get Campaign Status
Returns a progress snapshot for a campaign: its settings, a breakdown of call outcomes so far, and the state of every contact upload and its calling queue. Cheap to poll.
GET
/
v1
/
campaigns
/
{id}
/
status
Get campaign status
curl --request GET \
--url https://api.osvi.ai/v1/campaigns/{id}/status \
--header 'API-Token: <api-key>'import requests
url = "https://api.osvi.ai/v1/campaigns/{id}/status"
headers = {"API-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'API-Token': '<api-key>'}};
fetch('https://api.osvi.ai/v1/campaigns/{id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.osvi.ai/v1/campaigns/{id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"API-Token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.osvi.ai/v1/campaigns/{id}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("API-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.osvi.ai/v1/campaigns/{id}/status")
.header("API-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.osvi.ai/v1/campaigns/{id}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["API-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"campaign": {
"id": 7,
"name": "June Renewals",
"status": "active",
"is_retry_enabled": true,
"retry_threshold": 2,
"retry_delay": 1800,
"created_at": "2026-06-01T10:00:00+05:30"
},
"calls": {
"total": 120,
"by_status": {
"picked": 88,
"not_picked": 25,
"failed": 7
}
},
"uploads": [
{
"campaign_upload_id": 19,
"file_name": "1718000000-api_contacts_ab12cd34ef567890.csv",
"agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
"created_at": "2026-06-02T11:00:00+05:30",
"queues": [
{
"agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
"total_queued": 50,
"completed": false
}
]
}
]
}
}{
"success": false,
"error": "Invalid API token"
}{
"success": false,
"error": "Campaign not found",
"details": null
}Authorizations
16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.
Path Parameters
The campaign's numeric id.
⌘I
