## Create

`campaigns.create(CampaignCreateParams**kwargs)  -> CampaignCreateResponse`

**post** `/campaigns`

Create a new outbound calling campaign and launch it immediately. If scheduled_at is set, all calls will be queued until the specified time instead of starting right away.

### Parameters

- `assistant_id: str`

  The ID of the assistant to use

- `contacts: Iterable[Contact]`

  The list of contacts to call

  - `prompt_variables: Dict[str, str]`

  - `to_phone_number: str`

- `name: str`

  The name of the campaign

- `call_retry_config: Optional[CallRetryConfig]`

  Override retry configuration for calls in this campaign. If not provided, uses the assistant's retry config.

  - `calling_windows: Iterable[CallRetryConfigCallingWindow]`

    - `calling_window_end_time: str`

      End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

    - `calling_window_start_time: str`

      Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

    - `retry_delay_seconds: int`

      Delay between retry attempts in seconds. Default: 7200 (2 hours).

  - `max_retry_attempts: int`

    Maximum number of call retry attempts. Default: 3.

  - `timezone: Optional[str]`

    Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

- `from_phone_number: Optional[str]`

  The phone number to use for outbound calls (E.164 format, e.g., +1234567890)

- `max_concurrent_calls: Optional[float]`

  Maximum number of concurrent calls allowed for this campaign

- `scheduled_at: Optional[Union[Union[str, datetime], object]]`

  Schedule all calls in this campaign to start at a specific date and time (ISO 8601 format)

  - `Union[str, datetime]`

  - `object`

### Returns

- `class CampaignCreateResponse: …`

  - `campaign: Campaign`

    - `id: str`

    - `assistant_id: str`

    - `created_at: object`

    - `is_cancelled: bool`

    - `name: str`

    - `organization_id: str`

    - `status: Literal["draft", "running", "paused", "completed"]`

      - `"draft"`

      - `"running"`

      - `"paused"`

      - `"completed"`

    - `updated_at: object`

    - `assistant: Optional[CampaignAssistant]`

      - `id: str`

      - `background_sound: Optional[Literal["audio/office.ogg"]]`

        The background sound to play during the call. Useful to give the impression that your AI agent is in an office.

        - `"audio/office.ogg"`

      - `calendly: Optional[CampaignAssistantCalendly]`

        - `connection_id: str`

          The connection ID representing the link between your Calendly account and Revox.

        - `event_type_id: str`

          The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

      - `call_retry_config: Optional[CampaignAssistantCallRetryConfig]`

        Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

        - `calling_windows: List[CampaignAssistantCallRetryConfigCallingWindow]`

          - `calling_window_end_time: str`

            End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

          - `calling_window_start_time: str`

            Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

          - `retry_delay_seconds: int`

            Delay between retry attempts in seconds. Default: 7200 (2 hours).

        - `max_retry_attempts: int`

          Maximum number of call retry attempts. Default: 3.

        - `timezone: Optional[str]`

          Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

      - `created_at: object`

      - `end_of_call_sentence: Optional[str]`

      - `first_sentence: Optional[str]`

      - `first_sentence_delay_ms: int`

        Delay in milliseconds before speaking the first sentence. Default: 400.

      - `first_sentence_mode: Literal["generated", "static", "none"]`

        - `"generated"`

        - `"static"`

        - `"none"`

      - `ivr_navigation_enabled: bool`

        Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

      - `llm_model: CampaignAssistantLlmModel`

        - `class CampaignAssistantLlmModelUnionMember0: …`

          - `name: Literal["gpt-4.1", "ministral-3-8b-instruct"]`

            - `"gpt-4.1"`

            - `"ministral-3-8b-instruct"`

          - `type: Literal["dedicated-instance"]`

            - `"dedicated-instance"`

        - `class CampaignAssistantLlmModelUnionMember1: …`

          - `openrouter_model_id: str`

            The model ID to use from OpenRouter. eg: openai/gpt-4.1

          - `openrouter_provider: str`

            The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

          - `type: Literal["openrouter"]`

            Use a model from OpenRouter.

            - `"openrouter"`

      - `max_call_duration_secs: float`

        The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

      - `name: str`

      - `organization_id: str`

      - `prompt: str`

      - `structured_output_config: Optional[List[CampaignAssistantStructuredOutputConfig]]`

        The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

        - `name: str`

        - `required: bool`

        - `type: Literal["string", "number", "boolean", 3 more]`

          - `"string"`

          - `"number"`

          - `"boolean"`

          - `"enum"`

          - `"date"`

          - `"datetime"`

        - `description: Optional[str]`

        - `enum_options: Optional[List[str]]`

      - `transfer_phone_number: Optional[str]`

        Phone number to transfer calls to when users request to speak to a human agent.

      - `updated_at: object`

      - `voice: Optional[CampaignAssistantVoice]`

        - `id: str`

          The ID of the voice.

        - `provider: Literal["cartesia", "elevenlabs"]`

          The provider of the voice.

          - `"cartesia"`

          - `"elevenlabs"`

        - `speed: Optional[float]`

          The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

      - `voicemail_message: Optional[str]`

        If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

      - `webhook_url: Optional[str]`

        The webhook URL to call when the call is completed.

      - `faq_items: Optional[List[CampaignAssistantFaqItem]]`

        - `answer: str`

        - `question: str`

        - `id: Optional[str]`

        - `needs_human_answer: Optional[bool]`

        - `source: Optional[Literal["human", "ai"]]`

          - `"human"`

          - `"ai"`

      - `pending_faq_count: Optional[float]`

    - `call_retry_config: Optional[CampaignCallRetryConfig]`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: List[CampaignCallRetryConfigCallingWindow]`

        - `calling_window_end_time: str`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: str`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: int`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: int`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: Optional[str]`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `from_phone_number: Optional[str]`

    - `max_concurrent_calls: Optional[float]`

    - `row_stats: Optional[CampaignRowStats]`

      - `calling: float`

      - `completed: float`

      - `failed: float`

      - `pending: float`

      - `retry: float`

      - `total: float`

    - `scheduled_at: Optional[object]`

### Example

```python
import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
campaign = client.campaigns.create(
    assistant_id="assistant_id",
    contacts=[{
        "prompt_variables": {
            "foo": "string"
        },
        "to_phone_number": "to_phone_number",
    }],
    name="x",
)
print(campaign.campaign)
```