Kampanya maliyet tahmini


POST https://app.apsilo.com/api/public/v1/campaigns/estimate

Kampanya oluşturma gövdesiyle aynı (name isteğe bağlı); kayıt oluşturmadan alıcı dökümünü ve tahmini maliyeti döner.

Gerekli kapsam: campaigns:write

Parametreler

Parametre	Yer	Tip	Gereklilik	Açıklama
`Idempotency-Key`	başlık	string	isteğe bağlı	İsteğe özgü benzersiz değer (1–255 yazdırılabilir ASCII; ör. UUID). Aynı anahtar + aynı yol ve gövde 24 saat içinde kaydedilmiş yanıtı döner (`Idempotent-Replayed: true`); farklı gövde veya işlenmekte olan istek `409 IDEMPOTENCY_CONFLICT`. Hata yanıtları saklanmaz.
`X-Request-Id`	başlık	string	isteğe bağlı	İsteğe bağlı istek kimliğiniz (8–100 karakter: harf, rakam, `._:-`); yanıtta aynen döner ve kayıtlara işlenir.

İstek gövdesi

Alan	Tip	Gereklilik	Açıklama
`name`	string	isteğe bağlı
`templateId`	string (uuid)	zorunlu
`channelAccountId`	string (uuid)	isteğe bağlı
`audience`	object	zorunlu
`askValues`	object	isteğe bağlı	Varsayılan: `{}`.
`headerMediaId`	string (uuid) \| null	isteğe bağlı
`scheduledAt`	string (date-time) \| null	isteğe bağlı


{
  "templateId": "0b9e4c1a-6f2d-4a7b-9c3e-000000000080",
  "audience": {
    "type": "tags",
    "tags": [
      "VIP"
    ],
    "match": "any"
  }
}

Yanıtlar

Durum	Açıklama
`200`	Tahmin
`401`	Kimlik doğrulanamadı. Olası kodlar: `API_KEY_INVALID`, `API_KEY_REVOKED`, `API_KEY_EXPIRED`.
`403`	Erişim reddedildi. Olası kodlar: `FEATURE_NOT_LICENSED`, `API_SCOPE_MISSING`, `IP_NOT_ALLOWED`, `LICENSE_EXPIRED`, `LICENSE_NOT_FOUND`, `FORBIDDEN`.
`409`	Çakışma. Olası kodlar: `CONFLICT`, `IDEMPOTENCY_CONFLICT`, `MEDIA_IN_USE`, `SOCIAL_APPROVAL_REQUIRED`, `SOCIAL_POST_NOT_EDITABLE`.
`422`	İşlenemeyen istek. Olası kodlar: `VALIDATION_FAILED`, `MESSAGING_WINDOW_CLOSED`, `CHANNEL_ACCOUNT_MISSING`, `CONTACT_BLOCKED`, `STORAGE_LIMIT_REACHED`, `SOCIAL_POST_INVALID`, `SOCIAL_PLATFORM_UNAVAILABLE`.
`429`	Hız sınırı aşıldı. Olası kodlar: `RATE_LIMITED`.
`500`	Sunucu hatası. Olası kodlar: `INTERNAL`.

Örnek yanıt (200)


{
  "data": {
    "channel": "whatsapp",
    "matched": 1250,
    "sendable": 1184,
    "excluded": {
      "noIdentity": 12,
      "noConsent": 54,
      "blocked": 0,
      "outsideWindow": 0,
      "noPriorConversation": 0
    },
    "unitPrice": "0.045000",
    "estimatedCost": {
      "amount": "53.280000",
      "unit": "USD"
    },
    "balance": {
      "amount": "420.000000",
      "unit": "USD"
    },
    "sufficientBalance": true,
    "dailyDmLimit": null
  }
}