Skip to main content
POST
Campaign History

Authorizations

x-api-key
string
header
required

Query Parameters

id
string
required

The ID of the campaign

page
integer
default:0

Page index, starting at 0. Send -1 (with perpage=-1) to return all records.

perpage
integer
default:20

Number of records per page. Send -1 to return all records.

status
enum<string>

Filter by call status. Leave empty for all statuses.

Available options:
,
completed,
inProgress,
pending,
failed,
error
sentiment
enum<string>

Filter by call sentiment. Leave empty for all sentiments.

Available options:
,
positive,
negative,
neutral
favourite
enum<string>

Filter favourite contacts: true for favourites, false for non-favourites. Leave empty for all.

Available options:
,
true,
false
optOut
enum<string>

Filter by opt-out: true for contacts who opted out, false for subscribed contacts. Leave empty for all.

Available options:
,
true,
false

Search text matched against contact name, email and phone number.

sortBy
string

Field to sort by, for example phone, first_name, email, call_duration_in_sec, call_cost, called_at or created_at.

sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc

Response

Campaign audiences response

first_name
string

First name

last_name
string

Last name

description
string

Description

phone
string

phone number

status
string

Status

call_duration_in_sec
string

Call duration in second

call_sentiment
string

Call sentiment

calltranscribe
string

Call transcribe

is_call_transferred
boolean

Call transferred action

is_meeting_scheduled
boolean

Meeting scheduled action

is_message_sent
boolean

Message sent action

recording_url
string

Recording url

error
string

Error