Skip to main content
GET
Get campaign details

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Path Parameters

campaign_id
string<uuid>
required

Campaign UUID

Response

Campaign details

A campaign as list, get, create and update return it. Only list and get include inbound_phone_numbers.

id
string<uuid>
account_id
string<uuid>
name
string
description
string | null
status
enum<string>
Available options:
draft,
scheduled,
running,
paused,
completed,
failed,
cancelled
direction
enum<string>

outbound campaigns dial their leads. inbound campaigns are never dialled; they answer on a routed number only while running.

Available options:
outbound,
inbound
inbound_phone_numbers
object[]

Your active or verified numbers with inbound routing on and pointed at this campaign. Full inbound settings are on GET /v1/phone-numbers.

timezone
string | null

IANA timezone for the dispatch hours. schedule_time is always UTC.

schedule_time
string<date-time> | null
dispatch_hours_start
string | null

Daily start of the dispatch window, HH:MM:SS local time.

dispatch_hours_end
string | null

Daily end of the dispatch window, HH:MM:SS local time.

dispatch_weekdays
integer[]

Days dispatch may run. 1 is Monday, 7 is Sunday.

Required range: 1 <= x <= 7
dispatch_hours_overrides
object | null

Windows for specific weekdays, keyed "1" to "7". An empty list makes that day a day off.

max_attempts_per_lead
integer
max_parallel_calls
integer | null
conversion_outcomes
string[] | null

Dispositions that count toward success_count. Set in the dashboard; the API doesn't accept it.

outcome_mapping

Maps raw call outcomes to dispositions. Set in the dashboard. Expect an object, an empty array [] (the default) or null.

pause_reason
string | null

Why the campaign is paused: manual from the pause endpoint, or an automatic reason such as quota_exceeded, payment_failed or phone_number_deleted.

lead_list_ids
string<uuid>[]

Attached lead lists.

config
object

Configuration for every call the campaign places.

created_at
string<date-time>
updated_at
string<date-time> | null