List Campaign Calls

Returns a paginated list of calls for a specific campaign

GET /campaigns/{id}/calls

cURL

cURL

curl --request GET \
  --url https://api.altur.io/api/v1.0/campaigns/{id}/calls \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.altur.io/api/v1.0/campaigns/{id}/calls"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.altur.io/api/v1.0/campaigns/{id}/calls', 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.altur.io/api/v1.0/campaigns/{id}/calls",
  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: <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.altur.io/api/v1.0/campaigns/{id}/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<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.altur.io/api/v1.0/campaigns/{id}/calls")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.altur.io/api/v1.0/campaigns/{id}/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "total_count": 123,
  "calls": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "ended_reason": "<string>",
      "duration": 123,
      "billed_duration": 123,
      "contact": {
        "id": 123,
        "f_id": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "status": "<string>"
      },
      "extracted_data": {
        "interested": "yes",
        "appointment_date": "2024-01-20"
      },
      "tags": [
        "interested",
        "callback"
      ],
      "recording_url": "/api/v1.0/call/call_abc123def456/recording",
      "policy_evaluation": {
        "score": 123,
        "policies_evaluated_count": 123,
        "policies_met_count": 123,
        "policies_not_applicable_count": 123,
        "completed": true,
        "completed_at": "2023-11-07T05:31:56Z",
        "policies": [
          {
            "policy_id": "<string>",
            "policy_name": "<string>",
            "explanation": "<string>",
            "evaluated_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    }
  ],
  "pagination": {
    "page_index": 123,
    "page_size": 123,
    "has_next": true,
    "has_previous": true,
    "next_page": 123,
    "previous_page": 123
  }
}

{
  "field1": [
    "This field is required."
  ],
  "field2": [
    "Incorrect format."
  ],
  "non_field_errors": [
    "The date range is not valid."
  ]
}

{
  "error": 123,
  "message": "<string>"
}

{
  "error": 123,
  "message": "<string>"
}

Rate Limit: 12 requests per second

Authorizations

Authorization · string · header · required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Path Parameters

id · integer · required

The identifier of the Campaign to return the Calls

Query Parameters

status · enum<string>

Filters the Campaign Calls by the status of the Call

Available options: ended, failed, busy, no-answer, in-progress

answeredBy · enum<string>

Filters the Campaign Calls by who answered the call

Available options: human, machine, unknown

startDate · string<ISO 8601>

Filter calls created after this date in ISO 8601 format

endDate · string<ISO 8601>

Filter calls created before this date in ISO 8601 format

pageSize · integer · default: 50

Number of items per page to return.

Required range: 1 <= x <= 100

pageIndex · integer · default: 0

Page number to return (0-based).

Required range: 0 <= x <= 25000

Response

200

application/json

Campaign Calls response

total_count · integer

Total number of Campaign Calls for the given query.

calls · object[]

Show child attributes

pagination · object

Pagination information for campaign calls

Show child attributes