Wespoke
Dokümantasyon

Kampanya Detayı

Belirli bir kampanyanın detaylarını ve kişi listesini görüntüleyin

Endpoint

GET/api/v1/campaigns/:id

Kampanya detaylarını ve kişi listesini görüntüleyin. Sayfalama ile büyük kişi listelerini yönetin.

Path Parameters

idzorunlu

Kampanya ID'si

Query Parameters

contactsPageopsiyonel

Kişi listesi sayfa numarası (varsayılan: 1)

contactsLimitopsiyonel

Sayfa başına kişi sayısı (varsayılan: 50, maksimum: 500)

Örnek İstek

cURL
curl -X GET "https://api.wespoke.ai/api/v1/campaigns/camp_abc123?contactsPage=1&contactsLimit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Örnek Yanıt

200 OK
{
  "success": true,
  "data": {
    "campaign": {
      "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",
        "greetingMessage": "Merhaba, size özel bir teklifimiz var!",
        "specialInstructions": "Eğer müşteri ilgiliyse, detayları email ile gönder."
      },
      "createdAt": "2025-01-20T10:00:00Z",
      "updatedAt": "2025-01-20T14:30:00Z",
      "startedAt": "2025-01-20T11:00:00Z",
      "completedAt": null
    },
    "contacts": [
      {
        "id": "contact_1",
        "phoneNumber": "+905551234567",
        "name": "Ahmet Yılmaz",
        "status": "COMPLETED",
        "attempts": 1,
        "customData": {
          "segment": "premium",
          "lastPurchase": "2025-01-10"
        },
        "callId": "call_abc123",
        "lastAttemptAt": "2025-01-20T11:05:00Z",
        "createdAt": "2025-01-20T10:00:00Z"
      },
      {
        "id": "contact_2",
        "phoneNumber": "+905559876543",
        "name": "Ayşe Demir",
        "status": "PENDING",
        "attempts": 0,
        "customData": {},
        "callId": null,
        "lastAttemptAt": null,
        "createdAt": "2025-01-20T10:00:00Z"
      }
    ],
    "contactsPagination": {
      "page": 1,
      "limit": 50,
      "totalPages": 20,
      "totalContacts": 1000,
      "hasNextPage": true,
      "hasPreviousPage": false
    }
  }
}

Hata Yanıtları

404 Not Found

{
  "success": false,
  "error": {
    "message": "Campaign not found",
    "code": "CAMPAIGN_NOT_FOUND"
  }
}

💡Önemli Notlar

  • Kişi listesi varsayılan olarak sayfalanır (50 kişi/sayfa)
  • Maksimum 500 kişi tek bir istekte alınabilir
  • Her kişi için arama durumu ve deneme sayısı dahildir
  • customData alanı her kişiye özgü bilgiler içerir
  • Kampanya metadata'sı greeting mesajı ve özel talimatları içerir
Kampanyaları ListeleKampanya İstatistikleri