Kampanya alıcıları
GET https://app.apsilo.com/api/public/v1/campaigns/{id}/recipientsGerekli kapsam: campaigns:read
Parametreler
| Parametre | Yer | Tip | Gereklilik | Açıklama |
|---|---|---|---|---|
id | yol | string (uuid) | zorunlu | Kaynak kimliği (UUID) |
status | sorgu | pending · queued · accepted · sent · delivered · read · failed · skipped · bounced | isteğe bağlı | Alıcı durumu |
limit | sorgu | integer | isteğe bağlı | Sayfa boyutu |
cursor | sorgu | string | isteğe bağlı | Önceki yanıtın nextCursor değeri (opak) |
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. |
Yanıtlar
| Durum | Açıklama |
|---|---|
200 | Alıcılar |
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. |
404 | Bulunamadı. Olası kodlar: NOT_FOUND. |
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. |
Yanıt gövdesi
| Alan | Tip | Gereklilik | Açıklama |
|---|---|---|---|
data | CampaignRecipient[] | zorunlu | |
nextCursor | string,null | zorunlu | Sonraki sayfa için cursor değeri; son sayfada null. |