WHwhispa
ai-calls

Place Call

Place an outbound AI-collector call to phone_number.

Admin-only: placing outbound PSTN calls is a privileged, billable action. Returns the session_id you should subscribe to via GET /sessions/{session_id}/stream for live transcripts and action cards.

post/ai-calls

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

telephony_provider'threecx' | 'tcn' | 'twilio' nullable
phone_numberstring required

E.164 phone number to dial, e.g. +14155551212

scenariostring required

Scenario name with mode='ai_agent' (its scenario_metadata.voice_agent_config defines the persona).

crm_account_idstring nullable

Optional CRM account id to dial against. When CRM integration is enabled the account is resolved and mapped into the voice agent's context (unless an explicit demo_context is given), and the call session is auto-linked to it on placement.

override_complianceboolean

Admin escape hatch: skip the outbound compliance gate (do-not-call, suppression, contact windows, frequency caps) for this manual dial. The override is logged with the acting user.

voice_idstring nullable

Provider-qualified TTS voice for THIS call only, overriding the scenario's configured voice. Lets a voice be tried back-to-back without re-configuring the scenario (which would change it for every call in flight). The voice actually used is recorded on the call as tts_voice_id either way.

cartesia_voice_idstring nullable

Deprecated compatibility alias for voice_id.

Response

Successful Response

session_idstring uuid required

CallSession id; use as :session_id in /sessions/{id}/stream to subscribe to live events.

conversation_idstring required

The call's correlation handle — also stored in CallSession.agent_id.

Changes

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