apunkt/dograh
1
0
Fork 0
mirror of https://github.com/dograh-hq/dograh.git synced 2026-06-13 08:15:21 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add developer and api reference tabs (#190)

Browse source 
* docs: add developer and api reference tabs

* fix: remove duplicate image
This commit is contained in:
Sabiha Khan 2026-03-14 16:30:02 +05:30 • committed by GitHub
parent 1b03191cf8
commit f075bcb623
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
57 changed files with 1609 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/api-reference/campaigns.mdx Normal file
View file

@ -0,0 +1,29 @@
---
title: "Overview"
description: "Create and manage outbound calling campaigns"
---
A **campaign** runs a workflow against a list of contacts. You upload a CSV of phone numbers, configure retry logic and scheduling, then start the campaign. Dograh dials contacts automatically up to your configured concurrency limit.
| Method | Endpoint | Quick Link |
|---|---|---|
| `POST` | `/s3/presigned-upload-url` | [Upload contacts CSV](/api-reference/campaigns/upload-contacts) |
| `POST` | `/campaign/create` | [Create a campaign](/api-reference/campaigns/create) |
| `GET` | `/campaign/` | [List campaigns](/api-reference/campaigns/list) |
| `GET` | `/campaign/{campaign_id}` | [Get a campaign](/api-reference/campaigns/get) |
| `PATCH` | `/campaign/{campaign_id}` | [Update a campaign](/api-reference/campaigns/update) |
| `POST` | `/campaign/{campaign_id}/start` | [Start](/api-reference/campaigns/start) |
| `POST` | `/campaign/{campaign_id}/pause` | [Pause](/api-reference/campaigns/pause) |
| `POST` | `/campaign/{campaign_id}/resume` | [Resume](/api-reference/campaigns/resume) |
| `GET` | `/campaign/{campaign_id}/progress` | [Get campaign progress](/api-reference/campaigns/progress) |
| `GET` | `/campaign/{campaign_id}/runs` | [Get campaign call runs](/api-reference/campaigns/runs) |
## Campaign status values
| Status | Description |
|---|---|
| `draft` | Created but not started |
| `running` | Actively dialing contacts |
| `paused` | Temporarily stopped; can be resumed |
| `completed` | All contacts processed |
| `failed` | Campaign encountered a fatal error |