Create a campaign
Request body
Campaign name.
Campaign type. Only outbound campaigns are supported (dials contacts from a contact list).
UID of the bot that handles calls for this campaign.
Phone number to dial from in E.164 format (e.g. "+12025551234").
ID of the contact list to dial.
Start time for the daily calling window in HH:MM format (e.g. "09:00").
End time for the daily calling window in HH:MM format (e.g. "17:00").
IANA timezone for the calling window (e.g. "America/New_York"). Defaults to UTC if not specified.
Days of week to run the campaign (e.g. ["Monday", "Wednesday", "Friday"]). If not provided, campaign runs as single-day. Valid values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.
Response
Campaign created
Unique identifier.
Campaign name.
Campaign type (always outbound).
Current campaign status.
Bot UID for API reference.
Phone number used to dial from (E.164 format).
Associated contact list ID.
Daily calling window start time in HH:MM format.
Daily calling window end time in HH:MM format.
Calling window timezone (IANA format).
Days of week the campaign runs on (for recurring campaigns).
Schedule type: single (one-time) or multi (recurring on specific days).
Number of contacts already called.
Total number of contacts in the campaign's contact list.