Start a campaign (spends money)
Moves a draft campaign to running. Calls are released at the campaign's
rate and concurrency; answered contacts POST to the callback URL. Requires at
least one dialable contact, a valid callback URL and an owned caller ID. The
response carries the worst-case cost estimate.
Authorization
bearerAuth Long-lived ES256 JWT minted from the dashboard (https://app.sautikit.com/developers/api-keys). Signed by the
platform keyring. Carries workspace_id and scopes claims;
revoked via the platform deny-list.
In: header
Path Parameters
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/dialer/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/start"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "status": "draft", "mode": "drip", "caller_id": "string", "caller_ids": [ "string" ], "callback_url": "string", "release_rate_per_sec": 0, "max_concurrent": 0, "hours": { "timezone": "string", "windows": [ { "days": [ 0 ], "start_minute": 0, "end_minute": 1 } ], "blackouts": [ "2019-08-24" ] }, "timezone": "string", "retry": { "max_attempts": 1, "backoff_minutes": [ 0 ], "retry_on": [ "no_answer" ], "min_gap_minutes": 0, "ordering": "fifo" }, "budget_minor": 0, "daily_budget_minor": 0, "warn_pct": 0, "spent_minor": 0, "amd": { "mode": "off", "on_machine": "hangup", "max_analysis_seconds": 4, "machine_message": "string" }, "overflow": { "max_hold_ms": 2000, "hold_line_seconds": 10, "auto_ai": false, "auto_ai_after_seconds": 0, "ai_agent_id": "cbaf6aba-437a-4fd2-9d34-7875f81689e6", "callback_enabled": true, "callback_delay_minutes": 10, "callback_mode": "keypad", "callback_agent_id": "01422de9-87cc-4157-b531-8850ef02c157", "callback_prompt": "string", "hold_line_text": "string", "hold_line_url": "http://example.com", "callback_offer_text": "string", "callback_confirm_text": "string", "apology_text": "string" }, "summary": { "enabled": false, "engine": "extractive" }, "ratio_max": 0, "ratio_current": 0, "abandon_target_pct": 0, "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "estimate": { "contacts": 0, "max_attempts": 0, "telco_minor": 0, "amd_minor": 0, "total_minor": 0, "currency": "string", "budget_minor": 0, "exceeds_budget": true, "priced": true }, "callback_secret": "string"}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}Rotate the callback signing secret POST
Issues a new key for signing the campaign's answer callback and returns it once. The previous key stops signing immediately, in any campaign state, so update your verifier first or accept a short window of failed checks.
Pause a campaign POST
Stops new releases. Calls in flight finish. Only a `running` campaign can be paused.