Skip to main content
Creates a new outbound voice campaign. The campaign is created in draft status and must be started explicitly via the Start Campaign endpoint.

​
Request Body

  • name (string, required): A descriptive name for the campaign.
  • assistant_id (integer, required): The ID of the assistant that will handle connected calls.
  • from_phone_number (string, required): The caller ID phone number in E.164 format (e.g., +15551234567). Must be a number provisioned in your organization.
  • timezone (string): IANA timezone for the daily calling window (e.g., America/New_York). Defaults to UTC.
  • daily_window_start_local (string): Start of the daily calling window in HH:MM format. Defaults to 09:00.
  • daily_window_end_local (string): End of the daily calling window in HH:MM format. Defaults to 17:00.
  • max_concurrent (integer): Maximum number of simultaneous outbound calls. Defaults to 3.
  • min_interval_seconds (integer): Minimum seconds between initiating new calls. Defaults to 5.
  • amd_enabled (boolean): Enable answering machine detection. Defaults to true.
  • amd_options (object): Provider-specific AMD configuration options.
  • voicemail_drop_enabled (boolean): Automatically leave a voicemail when a machine is detected. Defaults to false.
  • voicemail_drop_media_uri (string): The media URI to play as the voicemail (e.g., sound:custom/vm-greeting). Required if voicemail_drop_enabled is true.
  • consent_enabled (boolean): Require DTMF consent before connecting to the AI assistant. Defaults to false.
  • consent_media_uri (string): The media URI to play as the consent prompt. Required if consent_enabled is true.
  • consent_timeout_seconds (integer): Seconds to wait for consent DTMF input. Defaults to 5.
  • settings (object): Additional campaign-level settings (reserved for future use).

​
Example Request

​
Response

Returns the created campaign object.