v17

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-173538121.5 KB
Campaigns

Get a campaign

get/v1/campaigns/{campaign_id}

Path parameters

campaign_idinteger required

Response

Campaign details

idinteger

Unique identifier.

namestring

Campaign name.

type'outbound'

Campaign type (always outbound).

status'Scheduled' | 'Running' | 'Stopped' | 'Completed' | 'Failed' | 'Expired' | 'Paused'

Current campaign status.

bot_uidstring

Bot UID for API reference.

from_numberstring

Phone number used to dial from (E.164 format).

contact_list_idinteger

Associated contact list ID.

time_startstring

Daily calling window start time in HH:MM format.

time_endstring

Daily calling window end time in HH:MM format.

timezonestring

Calling window timezone (IANA format).

daysstring[]

Days of week the campaign runs on (for recurring campaigns).

schedule_type'single' | 'multi'

Schedule type: single (one-time) or multi (recurring on specific days).

current_indexinteger

Number of contacts already called.

total_contactsinteger

Total number of contacts in the campaign's contact list.

created_atstring date-time
updated_atstring date-time