cURL
curl --request GET \
--url https://api.puretalk.ai/api/campaigns/{campaign_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.puretalk.ai/api/campaigns/{campaign_id}"
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://api.puretalk.ai/api/campaigns/{campaign_id}', 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.puretalk.ai/api/campaigns/{campaign_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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.puretalk.ai/api/campaigns/{campaign_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.puretalk.ai/api/campaigns/{campaign_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.puretalk.ai/api/campaigns/{campaign_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"msg": "Campaign retrieved successfully",
"err": false,
"results": {
"ai_assistant": {
"assistant_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Assistant",
"variables": [
"name"
]
},
"schedules": [
{
"campaign_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
"day": "Monday",
"start_time": "10:00",
"end_time": "11:00"
}
],
"campaign_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "call",
"name": "My Campaign",
"start_date": "2021-01-01",
"end_date": "2021-01-01",
"status": "active",
"created_at": "2021-01-01",
"updated_at": "2021-01-01",
"total_tasks": 100,
"completed_tasks": 100,
"pending_tasks": 100
}
}{
"err": false,
"msg": "Error message"
}Campaigns
Get Campaign
Returns a single campaign based on the ID supplied
GET
/
campaigns
/
{campaign_id}
cURL
curl --request GET \
--url https://api.puretalk.ai/api/campaigns/{campaign_id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.puretalk.ai/api/campaigns/{campaign_id}"
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://api.puretalk.ai/api/campaigns/{campaign_id}', 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.puretalk.ai/api/campaigns/{campaign_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-KEY: <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.puretalk.ai/api/campaigns/{campaign_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.puretalk.ai/api/campaigns/{campaign_id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.puretalk.ai/api/campaigns/{campaign_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"msg": "Campaign retrieved successfully",
"err": false,
"results": {
"ai_assistant": {
"assistant_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "My Assistant",
"variables": [
"name"
]
},
"schedules": [
{
"campaign_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
"day": "Monday",
"start_time": "10:00",
"end_time": "11:00"
}
],
"campaign_id": "123e4567-e89b-12d3-a456-426614174000",
"type": "call",
"name": "My Campaign",
"start_date": "2021-01-01",
"end_date": "2021-01-01",
"status": "active",
"created_at": "2021-01-01",
"updated_at": "2021-01-01",
"total_tasks": 100,
"completed_tasks": 100,
"pending_tasks": 100
}
}{
"err": false,
"msg": "Error message"
}Authorizations
Authorization header containing API key. You can find your API key in the dashboard under 'API Keys'.
Path Parameters
ID of campaign to return
Was this page helpful?
⌘I