Kampanyaları listele
GET/api/v1/campaigns
- Kapsam
read- SDK metodu
- listCampaigns · list_campaigns
- MCP aracı
listCampaignssalt okunur
Parametreler
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
bot_idsorgu | uuid | hayır | Yalnız bu bot |
statussorgu | enum | hayır | Durum süzgeci; başka değer 400 dönerdraft | pending_approval | approved | sending | completed | failed | cancelled |
limitsorgu | integer | hayır | Sayfa boyutu (1–200, varsayılan 100); tam sayı değilse 400val 1–200, default 100 |
cursorsorgu | string | hayır | Önceki yanıttaki next_cursor (opak; eski date-time imleçleri de kabul edilir) |
Örnek istek
curl -X GET "https://hiboty.com/api/v1/campaigns?limit=50" \
-H "Authorization: Bearer $HIBOTY_API_KEY"Örnek yanıt (200)
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"bot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Hiboty",
"status": "string",
"body": "string",
"template_name": "string",
"topic": "string",
"audience_count": 1,
"sent_count": 1,
"failed_count": 1,
"scheduled_at": "2026-11-06T09:00:00.000Z",
"started_at": "2026-11-06T09:00:00.000Z",
"completed_at": "2026-11-06T09:00:00.000Z",
"created_at": "2026-11-06T09:00:00.000Z",
"best_time": true,
"paused_at": "2026-11-06T09:00:00.000Z",
"pause_reason": "hata_orani"
}
],
"next_cursor": "string"
}Olası hatalar
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.