Campaigns

Campaigns let you orchestrate batches of outbound calls. Create a campaign, upload contacts, and dispatch — Rymi handles the Plivo dialing, DNC filtering, and status tracking.

Create Campaign

POST /campaigns

Field	Type	Required	Description
agent_id	string	✅	Agent persona to use for calls
name	string	✅	Human-readable campaign name
call_from_number	string	✅	Purchased Rymi number to dial from

Response 201

{ "status": "created", "campaign_id": "cmp_550e8400-..." }

List Campaigns

GET /campaigns

Get Campaign

GET /campaigns/:id

Update Campaign

PUT /campaigns/:id

Delete Campaign

DELETE /campaigns/:id

---

Campaign Contacts

Upload Contacts

Bulk upload contacts to a campaign. Each contact can include custom variables that the agent can reference during the call.

POST /campaigns/:id/contacts

curl -X POST https://api.rymi.ai/v1/campaigns/cmp_123/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "contacts": [
      { "phone_number": "15559990001", "variables": { "name": "Alice", "plan": "Gold" } },
      { "phone_number": "15559990002", "variables": { "name": "Bob", "plan": "Silver" } }
    ]
  }'

Response 201

{ "status": "success", "inserted_count": 2 }

List Contacts

GET /campaigns/:id/contacts

---

Campaign Lifecycle

Start Campaign

Dispatches calls to all pending contacts. Contacts on the DNC list are automatically skipped and marked as skipped_dnc.

POST /campaigns/:id/start

Response 200

{
  "message": "Campaign Dispatched Successfully",
  "contacts_dialed": 48,
  "contacts_skipped_dnc": 2
}

Pause Campaign

POST /campaigns/:id/pause

Response 200

{ "status": "paused", "id": "cmp_123" }

Resume Campaign

POST /campaigns/:id/resume

Response 200

{ "status": "running", "id": "cmp_123" }

Campaign Status Flow

draft → running → completed
              ↕
           paused

Contact Status Flow

pending → dialed → completed
                 → failed
       → skipped_dnc