v1

latestOpenAPI 3.0.02026-07-2633090.6 KB

campaign

Start Large Campaign Calls (Beta)

Beta endpoint for starting calls from a draft bulk list created by /campaign/upload-csv.

post/campaign/make-call-async

Headers

X-API-KEYstring required

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

(Required) Your Ringg AI API key.

Request body

bulk_list_idstring required

Draft bulk list ID returned by /campaign/upload-csv.

agent_idstring required

Assistant ID used during upload.

country_codestring required

Phone number country code.

campaign_start_timestring required

Campaign start time in DD/MM/YYYY, HH:MM format.

campaign_end_timestring required

Campaign end time in DD/MM/YYYY, HH:MM format.

from_numbersstring[] nullable

Explicit list of FromNumber UUIDs / phone numbers. Provide exactly one of from_numbers or number_pool_id.

number_pool_idstring nullable

Managed number pool ID (rotation, spam skipping, auto-purchase). Provide exactly one of from_numbers or number_pool_id.

concurrency_percentageinteger

callback_urlstring nullable

email_completion_user_idsstring[] nullable

Example request

{
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "country_code": "+91",
  "campaign_start_time": "18/10/2026, 09:00",
  "campaign_end_time": "18/10/2026, 18:00",
  "from_numbers": [
    "from-number-id"
  ],
  "number_pool_id": "pool-uuid-here",
  "call_config": {
    "call_retry_config": {
      "retry_count": 1,
      "retry_busy": 30,
      "retry_not_picked": 30,
      "retry_failed": 30
    },
    "call_time": {
      "call_start_time": "09:00",
      "call_end_time": "18:00",
      "timezone": "Asia/Kolkata"
    }
  },
  "concurrency_percentage": 25,
  "callback_url": "https://api.example.com/ringg/campaign-callback"
}

Response

Large campaign call creation accepted.

messagestring

bulk_list_idstring

statusstring

Example response

{
  "message": "Campaign calls scheduled",
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "scheduled"
}