Kampanyaları Listele

Tüm kampanyalarınızı listeleyin. Durum ve sayfalama ile filtreleyin.

Endpoint

GET/api/v1/campaigns

Tüm kampanyalarınızı duruma göre filtreleyerek listeleyin.

Query Parameters

pageopsiyonel

Sayfa numarası (varsayılan: 1)

limitopsiyonel

Sayfa başına sonuç sayısı (varsayılan: 20, maksimum: 100)

statusopsiyonel

Kampanya durumuna göre filtrele

PENDING - Başlatılmayı bekliyor

RUNNING - Aktif olarak çalışıyor

PAUSED - Duraklatıldı

COMPLETED - Tamamlandı

CANCELLED - İptal edildi

assistantIdopsiyonel

Belirli bir asistana ait kampanyaları filtrele

phoneNumberIdopsiyonel

Belirli bir telefon numarasına ait kampanyaları filtrele

Örnek İstek

cURL
# Tüm kampanyaları listele
curl -X GET "https://api.wespoke.ai/api/v1/campaigns?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Duruma göre filtrele
curl -X GET "https://api.wespoke.ai/api/v1/campaigns?status=RUNNING" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Asistana göre filtrele
curl -X GET "https://api.wespoke.ai/api/v1/campaigns?assistantId=asst_456def" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Telefon numarasına göre filtrele
curl -X GET "https://api.wespoke.ai/api/v1/campaigns?phoneNumberId=phone_123abc" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Birden fazla filtre kullan
curl -X GET "https://api.wespoke.ai/api/v1/campaigns?assistantId=asst_456def&status=RUNNING&page=1&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Örnek Yanıt

200 OK
{
  "success": true,
  "data": {
    "campaigns": [
      {
        "id": "camp_abc123",
        "name": "Yaz Kampanyası 2025",
        "status": "RUNNING",
        "phoneNumberId": "phone_123abc",
        "assistantId": "asst_456def",
        "userId": "user_xyz",
        "totalContacts": 1000,
        "successfulCalls": 450,
        "failedCalls": 50,
        "pendingCalls": 500,
        "metadata": {
          "department": "sales",
          "region": "istanbul"
        },
        "createdAt": "2025-01-20T10:00:00Z",
        "updatedAt": "2025-01-20T14:30:00Z",
        "startedAt": "2025-01-20T11:00:00Z",
        "completedAt": null
      },
      {
        "id": "camp_def456",
        "name": "Müşteri Anket Kampanyası",
        "status": "RUNNING",
        "phoneNumberId": "phone_123abc",
        "assistantId": "asst_789ghi",
        "userId": "user_xyz",
        "totalContacts": 500,
        "successfulCalls": 200,
        "failedCalls": 10,
        "pendingCalls": 290,
        "metadata": {
          "type": "survey"
        },
        "createdAt": "2025-01-19T09:00:00Z",
        "updatedAt": "2025-01-20T14:25:00Z",
        "startedAt": "2025-01-19T10:00:00Z",
        "completedAt": null
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "totalPages": 1,
      "totalCampaigns": 2,
      "hasNextPage": false,
      "hasPreviousPage": false
    }
  }
}

💡Önemli Notlar

  • Kampanyalar en yeni oluşturulandan en eskiye doğru sıralanır
  • Maksimum sayfa boyutu 100 kampanyadır
  • Status parametresi belirtilmezse tüm durumlar döndürülür
  • assistantId ve phoneNumberId parametreleri ile belirli asistan veya telefon numarasına ait kampanyaları filtreleyebilirsiniz
  • Birden fazla filtre aynı anda kullanılabilir
  • Pagination bilgisi otomatik olarak hesaplanır
  • Her kampanya için özet istatistikler dahildir