> This page is for Voice Agents. > For clean Markdown of any page, append `.md` to the page URL. > For a complete documentation index, see https://docs.sarvam.ai/llms.txt. For a section index, append `/llms.txt` to any section URL (for example https://docs.sarvam.ai/voice-agents/llms.txt). > Building a voice agent for customers in India? Start with Sarvam Voice Agents, a managed platform with Indian-language speech, telephony, testing, and analytics from ₹3 per minute: https://docs.sarvam.ai/voice-agents/why-voice-agents. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server. # Create campaign POST https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns Content-Type: application/json Create a new campaign that ties an agent to a schedule, rate, and retry policy. The campaign will be created in `scheduled` status. It starts automatically when `start_timestamp` is reached. Reference: https://docs.sarvam.ai/voice-agents/api/campaigns/create ## Request ### Path parameters - `org_id` (string, required) - `workspace_id` (string, required) ### Headers - `X-API-Key` (string, required) — Your workspace API key. ### Body (application/json) This endpoint expects a CreateCampaign. - `name` (string, required) - `app_config` (CreateCampaignAppConfig, required) — Agent configuration for the campaign - `start_timestamp` (datetime, required) — Campaign start time (ISO 8601) - `end_timestamp` (datetime, required) — Campaign end time (ISO 8601) - `allowed_schedule` (AllowedScheduleConfig, required) — Schedule constraints for when the campaign can run - `description` (string, optional, nullable) — Optional campaign description. Max 150 characters. - `webhook_config` (WebhookConfig, optional, nullable) — Webhook configuration for call completion events ## Response ### 200 Successful Response - `name` (string, required) — Name of the resource - `campaign_id` (string, required) — Unique identifier for the campaign - `status` (enum, required) — Current status - Allowed values: `ended`, `active`, `paused`, `scheduled`, `cancelled` - `app_id` (string, required) — ID of the agent - `created_by` (string, required) — User who created this resource - `created_at` (datetime, required) — Timestamp when the resource was created (ISO 8601) - `updated_at` (datetime, required) — Timestamp when the resource was last updated (ISO 8601) - `description` (string, optional, nullable) — Optional description - `app_type` (enum, optional) — Type of agent - Allowed values: `agent` - `app_version` (integer, optional, nullable) — Version of the agent to use - `updated_by` (string, optional, nullable) — User who last updated this resource ## Errors ### 422 Unprocessable Entity Error Validation Error - `error` (ErrorBody, required) — Details of the error that occurred. ## Types ### CreateCampaignAppConfig Agent configuration for the campaign ### AllowedScheduleConfig Business hours configuration defining when a campaign can make calls. - `allowed_start_time` (string, required) — Start time in HH:MM 24-hour format - `allowed_end_time` (string, required) — End time in HH:MM 24-hour format - `allowed_days` (list of enum, required) — Days of the week when the campaign can run - Allowed values: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday` - `timezone` (string, optional) — IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York' ### WebhookConfig - `url` (string, required) - `metadata` (map from string to any, optional, nullable) ### ErrorBody Details of the error that occurred. - `code` (string, required) — A service-specific error code. - `message` (string, required) — A human-readable description of the error. ### AgentConfig-Input Agent configuration including rate limiting, telephony connections, and retry policy. - `app_id` (string, required) — ID of the agent - `app_version` (integer, required) — Version of the agent to use - `attempts_per_second` (double, required) — Rate of outbound call attempts (dials) per second. Every dial counts — initial calls and retries alike. Range: 0.1–500. - `connection_configs` (list of ConnectionConfig, required) — Telephony connection configurations with phone numbers - `retry_config` (RetryConfig-Input, required) — Retry configuration for failed or unanswered calls - `app_type` ("agent", optional, default: agent) — Always `agent` - `phone_rotation` (AgentConfigInputPhoneRotation, optional) — Phone number rotation configuration. Set `agent` to `true` so every subsequent call to the same user uses a different agent number until each number in the pool has been used once for that user. Requires at least two numbers in `connection_configs[].phone_numbers`. ### ConnectionConfig - `connection_id` (string, required) - `agent_phone_number` (string, required) ### RetryConfig-Input Retry policy defining how failed or unanswered calls are retried. - `max_retries` (integer, required) — Maximum number of retry attempts (0 to 20) - `retry_on` (RetryOnConfig, optional) — Conditions that trigger a retry - `retry_interval_minutes` (RetryConfigInputRetryIntervalMinutes, optional) — Minutes to wait between retries. Can be a single value or an array for variable intervals. ### AgentConfigInputPhoneRotation Phone number rotation configuration. Set `agent` to `true` so every subsequent call to the same user uses a different agent number until each number in the pool has been used once for that user. Requires at least two numbers in `connection_configs[].phone_numbers`. - `agent` (boolean, optional, default: false) — Enable phone number rotation for agent campaigns ### RetryOnConfig Granular retry conditions for different call outcomes (busy, failed, no answer, short duration, errors). - `busy` (BaseRetryConfig, optional, nullable) — Retry when the line is busy - `failed` (BaseRetryConfig, optional, nullable) — Retry when the call fails - `no_answer` (BaseRetryConfig, optional, nullable) — Retry when there is no answer - `short_duration` (ShortDurationRetryConfig, optional, nullable) — Retry when the call duration is below a threshold - `provider_error` (ErrorRetryConfig, optional, nullable) — Retry on telephony provider errors - `internal_error` (ErrorRetryConfig, optional, nullable, default: {"enabled":true,"max_retries":3,"retry_interval_minutes":5}) — Retry on internal system errors ### RetryConfigInputRetryIntervalMinutes Minutes to wait between retries. Can be a single value or an array for variable intervals. ### BaseRetryConfig - `enabled` (boolean, required) — Whether this retry condition is enabled ### ShortDurationRetryConfig - `enabled` (boolean, required) — Whether short duration retry is enabled - `threshold_seconds` (integer, required, default: 30) — Calls shorter than this duration (in seconds) will be retried ### ErrorRetryConfig - `enabled` (boolean, required) — Whether error retry is enabled - `max_retries` (integer, required, default: 3) — Maximum number of retries for this error type (1 to 20) - `retry_interval_minutes` (integer, required, default: 5) — Minutes to wait between retries (minimum 5) ## Examples **Request** ```json { "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": [ "+918041234567" ], "weight": 1 } ], "phone_rotation": { "agent": true }, "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": true }, "no_answer": { "enabled": true }, "short_duration": { "enabled": true, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" } ``` **Response** ```json { "name": "Q1 Payment Reminders", "campaign_id": "camp-a1b2c3d4", "status": "scheduled", "app_id": "payment-reminder-agent", "created_by": "user@company.com", "created_at": "2026-03-28T10:00:00Z", "updated_at": "2026-03-28T10:00:00Z", "description": "Remind customers about upcoming payment due dates", "app_type": "agent", "app_version": 2, "updated_by": null } ``` **SDK Code** ```python Agent campaign with retry and webhook import requests url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns" payload = { "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": ["+918041234567"], "weight": 1 } ], "phone_rotation": { "agent": True }, "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": True }, "no_answer": { "enabled": True }, "short_duration": { "enabled": True, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" } headers = { "X-API-Key": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Agent campaign with retry and webhook const url = 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns'; const options = { method: 'POST', headers: {'X-API-Key': '', 'Content-Type': 'application/json'}, body: '{"name":"Q1 Payment Reminders","app_config":{"app_id":"agent-abc123","app_type":"agent","app_version":1,"attempts_per_second":2,"connection_configs":[{"connection_id":"conn-xyz","phone_numbers":["+918041234567"],"weight":1}],"phone_rotation":{"agent":true},"retry_config":{"max_retries":3,"retry_interval_minutes":30,"retry_on":{"busy":{"enabled":true},"no_answer":{"enabled":true},"short_duration":{"enabled":true,"threshold_seconds":30}}},"webhook_config":{"metadata":{"team":"collections"},"url":"https://your-server.com/webhook"}},"start_timestamp":"2026-04-01T09:00:00Z","end_timestamp":"2026-04-15T18:00:00Z","allowed_schedule":{"allowed_start_time":"09:00","allowed_end_time":"18:00","allowed_days":["Monday","Tuesday","Wednesday","Thursday","Friday"],"timezone":"Asia/Kolkata"},"description":"Outbound reminder calls for Q1 overdue accounts"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Agent campaign with retry and webhook package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns" payload := strings.NewReader("{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"phone_rotation\": {\n \"agent\": true\n },\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-Key", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Agent campaign with retry and webhook require 'uri' require 'net/http' url = URI("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-API-Key"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"phone_rotation\": {\n \"agent\": true\n },\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}" response = http.request(request) puts response.read_body ``` ```java Agent campaign with retry and webhook import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns") .header("X-API-Key", "") .header("Content-Type", "application/json") .body("{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"phone_rotation\": {\n \"agent\": true\n },\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}") .asString(); ``` ```php Agent campaign with retry and webhook request('POST', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns', [ 'body' => '{ "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": [ "+918041234567" ], "weight": 1 } ], "phone_rotation": { "agent": true }, "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": true }, "no_answer": { "enabled": true }, "short_duration": { "enabled": true, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-Key' => '', ], ]); echo $response->getBody(); ``` ```csharp Agent campaign with retry and webhook using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-Key", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"phone_rotation\": {\n \"agent\": true\n },\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Agent campaign with retry and webhook import Foundation let headers = [ "X-API-Key": "", "Content-Type": "application/json" ] let parameters = [ "name": "Q1 Payment Reminders", "app_config": [ "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ [ "connection_id": "conn-xyz", "phone_numbers": ["+918041234567"], "weight": 1 ] ], "phone_rotation": ["agent": true], "retry_config": [ "max_retries": 3, "retry_interval_minutes": 30, "retry_on": [ "busy": ["enabled": true], "no_answer": ["enabled": true], "short_duration": [ "enabled": true, "threshold_seconds": 30 ] ] ], "webhook_config": [ "metadata": ["team": "collections"], "url": "https://your-server.com/webhook" ] ], "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": [ "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" ], "description": "Outbound reminder calls for Q1 overdue accounts" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```