List Calls
curl --request GET \
--url https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list', 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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Calls fetched successfully.",
"data": [
{
"_id": "<string>",
"configId": "<string>",
"phoneNumber": "<string>",
"status": "received",
"outcome": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"collectedInformation": {},
"conversationId": "<string>",
"retryCount": 123,
"maxRetries": 123,
"tags": [
"<string>"
],
"review": {
"status": "not_required",
"by": "5eb7cf5a86d9755df3a6c593",
"timestamp": "2023-11-07T05:31:56Z",
"reason": "<string>",
"emails": [
"<string>"
],
"emailSent": false,
"emailSentAt": "2023-11-07T05:31:56Z",
"checklist": {}
},
"processTimings": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"statusHistory": [
{
"status": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"totalCount": 123,
"page": 123,
"size": 123
}{
"message": "Resource not found."
}{
"message": "Resource not found."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"message": "Resource not found."
}Campaigns Calls
List Calls
Fetch a paginated list of call records for a campaign.
- page / size: Pagination (default: page=1, size=50, max size=200).
- start / end: ISO 8601 date range filter on call creation date.
- status: Filter by call status (received, ready, queued, ringing, processing, ended, completed, failed).
- search: Search term matched against phone number or other call fields.
- outcomes: Repeat to filter by multiple outcomes:
?outcomes=voicemail&outcomes=no_answer. - tags: Repeat to filter by multiple tags:
?tags=region:west&tags=priority:high. - groupId: When provided, returns calls across all campaign runs in the group.
GET
/
campaigns
/
v1
/
campaigns
/
{campaign_id}
/
calls
/
list
List Calls
curl --request GET \
--url https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list', 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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/campaigns/{campaign_id}/calls/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "Calls fetched successfully.",
"data": [
{
"_id": "<string>",
"configId": "<string>",
"phoneNumber": "<string>",
"status": "received",
"outcome": "<string>",
"errorCode": "<string>",
"errorMessage": "<string>",
"collectedInformation": {},
"conversationId": "<string>",
"retryCount": 123,
"maxRetries": 123,
"tags": [
"<string>"
],
"review": {
"status": "not_required",
"by": "5eb7cf5a86d9755df3a6c593",
"timestamp": "2023-11-07T05:31:56Z",
"reason": "<string>",
"emails": [
"<string>"
],
"emailSent": false,
"emailSentAt": "2023-11-07T05:31:56Z",
"checklist": {}
},
"processTimings": {
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
},
"statusHistory": [
{
"status": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"totalCount": 123,
"page": 123,
"size": 123
}{
"message": "Resource not found."
}{
"message": "Resource not found."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"message": "Resource not found."
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Path Parameters
Campaign configuration ID
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Query Parameters
Call status
Search keywords
Outcome values to filter by
Filter by tags (format: key:value)
Filter by group ID
When true, return only soft-deleted calls
Number of items per page
Required range:
x >= 1Page number
Required range:
x >= 1Filter by start time (ISO 8601 format)
Filter by end time (ISO 8601 format)
Response
Paginated list of call records
Result description
Example:
"Calls fetched successfully."
Paginated list of call record objects
Show child attributes
Show child attributes
Total number of calls matching the applied filters
Current page number (1-indexed)
Number of items returned on this page