v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

campaign

Start Campaign

Initiates a new campaign with the specified configuration.

post/campaign/start

Headers

X-API-KEYstring required

Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Request body

agent_idstring required

(Required) ID of the agent that will handle the calls.

list_idstring required

(Required) ID of the uploaded campaign contact list.

from_numbersstring[] required

(Required) Array of phone numbers to use for outbound calls.

Example request

{
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "list_id": "123e4567-e89b-12d3-a456-426614174000",
  "from_numbers": [
    "+1234567890"
  ]
}

Response

Campaign started successfully.

statusstring

Success message indicating campaign registration

has_ongoing_callsboolean

Whether the workspace has other ongoing calls

Example response

{
  "status": "campaign registered successfully!",
  "has_ongoing_calls": false
}