خودکارسازی‌ها و رویدادها
همهٔ فرمان‌های خودکارسازی‌ها، افراد درونشان و رویدادهایی که آن‌ها را جلو می‌برند، با نمونه‌های کاربردی.
چطور کنار هم قرار می‌گیرند
خودکارسازی یک آغازگر و درختی از گام‌هاست. یک پیش‌نویس و یک نسخهٔ فعال نگه می‌دارد: update پیش‌نویس و تنظیمات را تغییر می‌دهد، و publish پیش‌نویس را ثابت می‌کند و خودکارسازی را روشن می‌کند. خواندن به automations:read و تغییر دادن به automations:write نیاز دارد. publish، resume و send-test به emails:send هم نیاز دارند، چون باعث می‌شوند خودکارسازی نامه بفرستد.
openemail automations create --name "Welcome series" --starter welcome-seriesopenemail automations update aut_5c1e9a7b3d2f48e6a0b4c7d1 --data @welcome.jsonopenemail automations publish aut_5c1e9a7b3d2f48e6a0b4c7d1openemail automations stats aut_5c1e9a7b3d2f48e6a0b4c7d1تعریف JSON است، پس آن را در یک فایل بنویسید و با --data @file بدهید. openemail automations get <id> --json تعریف کنونی را چاپ می‌کند، و problems آن فهرست می‌کند چه چیزی هنوز جلوی انتشارش را می‌گیرد.
خودکارسازی‌ها
| فرمان | چه می‌کند |
|---|---|
| openemail automations list | یک صفحه از خودکارسازی‌ها، به ترتیب تازه‌ترین تغییر. --status آن را به draft، live، paused یا archived محدود می‌کند |
| openemail automations create --name <value> | یک پیش‌نویس از --starter، از تعریفی در --data، یا یک پیش‌نویس خالی بسازید |
| openemail automations get <id> | یک خودکارسازی با پیش‌نویس، نسخهٔ فعال، تنظیماتش و مشکل‌های پیش‌نویس |
| openemail automations update <id> | نام، تنظیمات یا تعریف پیش‌نویس را تغییر دهید. --expected-updated-at نمی‌گذارد روی تغییری که پس از خواندن شما انجام شده نوشته شود |
| openemail automations publish <id> | پیش‌نویس را به‌عنوان نسخهٔ بعدی ثابت کنید و خودکارسازی را روشن کنید |
| openemail automations pause <id> | یک خودکارسازی فعال را متوقف کنید. همهٔ افراد درون آن همان‌جا که هستند می‌مانند |
| openemail automations resume <id> | یک خودکارسازی متوقف را با همان نسخه‌ای که اجرا می‌کرد دوباره روشن کنید |
| openemail automations archive <id> | یک خودکارسازی را برای همیشه کنار بگذارید و سابقه‌اش را نگه دارید. همهٔ افراد درونش خارج می‌شوند |
| openemail automations duplicate <id> | یک خودکارسازی را در یک پیش‌نویس تازه کپی کنید، بدون افراد و آمارش |
| openemail automations delete <id> | حذف یک خودکارسازی و سابقه‌اش پس از تأیید شما. ورود با مرورگر کد تأیید هویت هم می‌خواهد |
| openemail automations list-starters | نقطه‌های شروعی که یک خودکارسازی تازه می‌تواند از آن‌ها آغاز شود |
آزمون، نسخه‌ها و آمار
| فرمان | چه می‌کند |
|---|---|
| openemail automations send-test <id> --step-key <value> | یک گام ایمیل پیش‌نویس را با مقدارهای نمونه برای خودتان، یا به --to، بفرستید. کسی را ثبت نمی‌کند |
| openemail automations list-versions <id> | همهٔ نسخه‌های منتشرشده، تازه‌ترین در ابتدا |
| openemail automations restore-version <id> <version> | یک نسخهٔ قبلی را به پیش‌نویس برگردانید. برای اجرا شدنش منتشر کنید |
| openemail automations stats <id> | جمع‌ها، یک ردیف برای هر گام و یک نقطه برای هر روز. --since آغاز بازهٔ زمانی را تعیین می‌کند، و پیش‌فرضش 30 روز گذشته است |
افراد درون یک خودکارسازی
| فرمان | چه می‌کند |
|---|---|
| openemail automations list-enrollments <id> | افرادی که وارد شده‌اند، تازه‌ترین در ابتدا، با گامی که هر کدام در آن است. --status و --step-key آن را محدود می‌کنند، و --all همهٔ صفحه‌ها را می‌خواند |
| openemail automations get-enrollment <id> <enrollment-id> | مسیر یک فرد، با هر گامی که اجرا شد و ایمیلی که هر ارسال ساخت |
| openemail automations enroll <id> --email <value> | یک مخاطب را از گام اول وارد یک خودکارسازی فعال کنید. --contact-id به‌جای آن مخاطب را با شناسه مشخص می‌کند |
| openemail automations exit-enrollment <id> <enrollment-id> | خارج کردن کسی پیش از آنکه تمام کند |
openemail automations list-enrollments aut_5c1e9a7b3d2f48e6a0b4c7d1 --status active --all --json | jq -r '.items[] | .contact.email + " " + (.stepKey // "")'رویدادها
رویداد می‌گوید یک مخاطب در محصول شما کاری کرده است. هر خودکارسازی فعالی را که آغازگرش آن را نام می‌برد شروع می‌کند و هر کسی را که منتظرش بود جلو می‌برد. فرستادنش به contacts:write نیاز دارد.
| فرمان | چه می‌کند |
|---|---|
| openemail events send --name <value> --email <value> | یک رویداد برای یک مخاطب ثبت کنید. --create-contact وقتی هنوز کسی آن نشانی را ندارد مخاطب را اضافه می‌کند، و --idempotency-key تلاش دوباره را امن می‌کند |
| openemail events send-batch <events> | تا 100 رویداد را از یک فایل JSON ثبت کنید، و چاپ کنید کدام‌ها پذیرفته و کدام‌ها رد شدند |
| openemail events list-names | نام رویدادهایی که فضای کاری فرستاده است، برای انتخاب یکی در یک آغازگر |
| openemail contacts list-events <email> | رویدادهای یک مخاطب، تازه‌ترین در ابتدا. --name آن را به یک رویداد محدود می‌کند |
openemail events send --data '{"name":"order.placed","email":"[email protected]","properties":{"orderId":"AC-4192"}}' --idempotency-key order:AC-4192:placedopenemail events send-batch @events.jsonopenemail contacts list-events [email protected] --name order.placedویژگی‌ها در بدنهٔ JSON می‌روند، پس رویدادی را که ویژگی دارد با --data بفرستید. رویدادها 90 روز نگه داشته می‌شوند.