Skip to main content

CreateCampaign creates a new outbound campaign.

POST 
/api/v1/voice/campaigns

Configures campaign settings including type, dialing mode, and routing options.

Parameters​

  • name: Required, campaign name
  • description: Optional, campaign description
  • queue_id: Optional, queue for agent routing
  • type: Optional, campaign type (default: agent_outbound)
  • dialing_mode: Optional, dialing strategy (default: progressive)
  • dial_ratio: Optional, lines per agent for predictive
  • max_lines: Optional, maximum concurrent outbound lines
  • retry_attempts: Optional, number of retry attempts
  • retry_delay: Optional, delay between retries in seconds
  • caller_id: Optional, outbound caller ID

Response​

Returns the created campaign with status = queued.

Errors​

  • INVALID_ARGUMENT: Invalid configuration values
  • NOT_FOUND: Referenced queue not found
  • PERMISSION_DENIED: Caller lacks voice:campaign:write permission

Request​

Responses​

A successful response.