WHwhispa
campaigns

Create Campaign

Create a draft campaign for an ai_agent scenario (admin only).

post/campaigns

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Request body

namestring required
scenariostring required

ai_agent scenario name

policy_overridesobject
supervisedboolean

Supervised (dialer) mode: one call in flight at a time, and the campaign holds after every call until the operator resumes.

max_concurrent_callsinteger

How many of this campaign's calls may be in flight at once. The runtime's global capacity cap (AI_CALL_MAX_CONCURRENT) still applies underneath, and supervised mode pins the effective value to 1.

voice_idstring nullable

Provider-qualified TTS voice id for this campaign's dials, overriding the scenario's own voice. Null/empty = speak with the scenario's voice.

cartesia_modelstring nullable

Cartesia TTS model id for this campaign's dials, overriding the scenario's own model. Null/empty = synthesize with the scenario's model.

opening_linestring nullable

Opening line for this campaign's dials, overriding the scenario's own. A $placeholder template — $agent_name, $company_name, $customer_name and $customer_first_name are substituted per call; any other placeholder stays literal, because the opener is spoken before identity is verified. Null/empty = speak the scenario's opening line.

Response

Successful Response

idstring uuid required
namestring required
scenariostring required
providerstring required
statusstring required
supervisedboolean
max_concurrent_callsinteger
voice_idstring nullable
cartesia_modelstring nullable
opening_linestring nullable
policy_overridesobject
archived_atstring date-time nullable
created_bystring uuid nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.