API

فهرست گیرندگان یک ارسال گروهی

همهٔ کسانی که ارسال گروهی برایشان رفت، یک سطر برای هر نسخه، مرتب‌شده بر اساس نشانی: شناسهٔ نسخه، وضعیتش، زمان ارسال و تحویل، اینکه برگشت خورد یا به عنوان هرزنامه گزارش شد، چند بار باز و کلیک شد، و اینکه آن شخص پس از ارسال لغو اشتراک کرد یا نه.

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

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

GET /broadcasts/{id}/recipients

پارامترها

idstringالزامی: در مسیر. یک شناسهٔ `brd_` از `POST /broadcasts` یا `GET /broadcasts`.
filterstring: فقط یک گروه را نگه می‌دارد: `pending` (هنوز در صف یا در حال ارسال)، `sent`، `delivered`، `opened`، `not_opened` (فرستاده‌شده و هرگز بازنشده)، `clicked`، `bounced`، `complained`، `failed` (ناموفق یا لغوشده) یا `unsubscribed`.
qstring: نشانی و نام را بدون توجه به کوچکی و بزرگی حروف جست‌وجو می‌کند. حداکثر 200 نویسه.
limitinteger: تعداد سطر در هر صفحه، از 1 تا 200. پیش‌فرض 50 است.
cursorstring: `nextCursor` صفحهٔ قبل، همان‌طور که آمده بازگردانده می‌شود، با همان `filter` و `q`. جای آخرین سطر را نگه می‌دارد، پس سطری که میان صفحه‌ها تغییر کند هرگز پیمایش را به هم نمی‌زند.

نمونه

به emails:read نیاز دارد. پاسخ صفحه‌ای از سطرهای broadcast_recipient است.

curl

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

پاسخ

{  "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"}

باز کردن‌ها و کلیک‌ها پراکسی‌های تصویر و اسکنرهای لینک را کنار می‌گذارند، و وقتی ارسال گروهی با ردیابی خاموش فرستاده شده باشد 0 می‌مانند.

status وضعیت نسخه در گزارش ارسال است: queued، scheduled، sending، sent، failed یا cancelled. deliveredAt، bouncedAt و complainedAt نخستین email.delivered، email.bounced و email.complained آن هستند، و failure می‌گوید چرا یک نسخه ناموفق بود.

unsubscribedAt زمانی است که آن شخص پس از ارسال، از طریق لینک آن یا به هر راه دیگری، از یکی از گروه‌های مخاطب ارسال گروهی لغو اشتراک کرد. contactId وقتی مخاطب از آن پس حذف شده باشد null است.

emailId شناسهٔ msg_ نسخه است. GET /broadcasts/{id}/recipients/{emailId} آن را همراه محتوایش می‌خواند، و GET /emails/{id} آن را به عنوان یک ایمیل ارسال‌شده می‌خواند.

ردها

وضعیت	کد	چه زمانی
400	`invalid_cursor`	در فهرست گیرندگان، یک `cursor` که آن فهرست تحویل نداده است.
403	`insufficient_scope`	کلید `emails:read` را ندارد.
404	`broadcast_not_found`	شناسه هیچ ارسال گروهی‌ای را در این فضای کاری نام نمی‌برد، یا کلید به نشانی‌ها یا دامنه‌های خاصی محدود است و ارسال گروهی از جایی فرستاده شده که کلید آن را ندارد.
404	`recipient_not_found`	در `GET /broadcasts/{id}/recipients/{emailId}`، یک `emailId` که نسخه‌ای از این ارسال گروهی نیست.