API

Bir toplu gönderimin alıcılarını listeleme

Toplu gönderimin gittiği herkes, kopya başına bir satır, adrese göre sıralı: kopya kimliği, durumu, ne zaman gönderildiği ve teslim edildiği, geri dönüp dönmediği ya da spam olarak bildirilip bildirilmediği, kaç kez açıldığı ve tıklandığı ve gönderimden sonra kişinin abonelikten çıkıp çıkmadığı.

GETapi.openemail.uk/broadcasts/{id}/recipients

Gerçek çağrıyı kendi anahtarınızla çalışma alanınıza karşı çalıştırır.

GET /broadcasts/{id}/recipients

Parametreler

idstringzorunlu: Yolun içinde. `POST /broadcasts` ya da `GET /broadcasts` yanıtından gelen bir `brd_` kimliği.
filterstring: Tek bir grubu tutar: `pending` (hâlâ kuyrukta ya da gönderiliyor), `sent`, `delivered`, `opened`, `not_opened` (gönderilmiş ve hiç açılmamış), `clicked`, `bounced`, `complained`, `failed` (başarısız ya da iptal edilmiş) veya `unsubscribed`.
qstring: Adreste ve adda, büyük/küçük harf ayrımı yapmadan arar. En fazla 200 karakter.
limitinteger: Sayfa başına satır, 1 ile 200 arası. Varsayılan 50.
cursorstring: Önceki sayfanın `nextCursor` değeri, geldiği gibi, aynı `filter` ve `q` ile geri gönderilir. Son satırın nerede durduğunu tutar, bu yüzden sayfalar arasında değişen bir satır dolaşmayı asla bozmaz.

Örnek

emails:read gerekir. Yanıt, broadcast_recipient satırlarından oluşan bir sayfadır.

curl

curl "$OE/broadcasts/brd_5a8c1e3f7b2d94a06c8e1f3b/recipients?filter=opened&limit=50" -H "$AUTH"

Yanıt

{  "object": "list",  "data": [    {      "object": "broadcast_recipient",      "emailId": "msg_01dad25067bc4dac966d515d",      "contactId": "6f1c2a8e-3b4d-4e9f-a1c7-2d5e8b0f9a34",      "email": "[email protected]",      "name": "Ada Lovelace",      "status": "sent",      "sentAt": "2026-09-23T12:00:09.000Z",      "deliveredAt": "2026-09-23T12:00:11.000Z",      "bouncedAt": null,      "complainedAt": null,      "failure": null,      "opens": 3,      "firstOpenAt": "2026-09-23T12:14:30.000Z",      "clicks": 1,      "firstClickAt": "2026-09-23T12:15:02.000Z",      "unsubscribedAt": null    }  ],  "hasMore": true,  "nextCursor": "WyJhZGFAZXhhbXBsZS5jb20iLCJtc2dfMDFkYWQyNTA2N2JjNGRhYzk2NmQ1MTVkIl0"}

Açmalar ve tıklamalar görsel proxy'lerini ve bağlantı tarayıcılarını dışarıda bırakır ve toplu gönderim izleme kapalıyken gönderildiyse 0 kalır.

status, kopyanın gönderim günlüğündeki durumudur: queued, scheduled, sending, sent, failed ya da cancelled. deliveredAt, bouncedAt ve complainedAt onun için ilk email.delivered, email.bounced ve email.complained olaylarıdır; failure ise bir kopyanın neden başarısız olduğunu söyler.

unsubscribedAt, kişinin gönderimden sonra toplu gönderimin kitlelerinden birinden, bağlantısı üzerinden ya da başka bir yolla abonelikten çıktığı zamandır. Kişi o zamandan beri silindiyse contactId null olur.

emailId, kopyanın msg_ kimliğidir. GET /broadcasts/{id}/recipients/{emailId} onu içeriğiyle birlikte okur, GET /emails/{id} ise gönderilmiş bir e-posta olarak okur.

Retler

Durum	Kod	Ne zaman
400	`invalid_cursor`	Alıcı listesinde, o listenin vermediği bir `cursor`.
403	`insufficient_scope`	Anahtarda `emails:read` yok.
404	`broadcast_not_found`	Kimlik bu çalışma alanında hiçbir toplu gönderimi adlandırmıyor ya da anahtar belirli adreslerle veya alan adlarıyla sınırlı ve toplu gönderim onun sahip olmadığı birinden gönderilmiş.
404	`recipient_not_found`	`GET /broadcasts/{id}/recipients/{emailId}` üzerinde, bu toplu gönderimin kopyası olmayan bir `emailId`.