هر کاری که میتوانید در Zinn® Campaigns در داشبورد انجام دهید، از طریق API نیز قابل انجام است و بخش عمده آن را میتوانید از طریق یک دستیار هوش مصنوعی متصل به حسابتان از طریق MCP انجام دهید. این راهنما ورود به سیستم، مجوزها، یک مثال عملی برای هر دو روش، محدودیتها، خطاها و تکتک ۸۹ عملیات Campaigns را پوشش میدهد. فهرست عملیات زیر از مشخصات API ما تولید شده است، بنابراین همیشه با عملکرد API مطابقت دارد. تمام فیلدهای هر عملیات در مرجع API در zinndigital.com/developers/api/zinn-campaigns موجود است.
ورود به سیستم
- کلیدهای API. یک کلید در پیشخوان در بخش تنظیمات ← کلیدهای API ایجاد کنید و آن را بهصورت
Authorization: Bearer zdk_live_… ارسال نمایید (یک کلید zdk_test_… در حالت جعبه شنی کار میکند). فقط مجوزهای مربوط به کمپینها را که کلید نیاز دارد به آن اختصاص دهید و نه بیشتر.
- دستیاران هوش مصنوعی (MCP). Claude، ChatGPT، Cursor یا هر کلاینت MCP دیگری را از طریق ورود به سیستم از برنامه یا با یک نشانه اتصال (
zmcp_live_…) به https://api.zinndigital.com/v1/mcp متصل کنید. بخش اتصال Claude، Cursor یا ChatGPT به حساب کاربری خود را ببینید. در صفحه رضایت، مجوزهای Zinn® Campaigns را علامت بزنید.
- مجوزها. مقدار
email_marketing.view کمپینها، فهرستها، مخاطبان، فرمها، فرستندگان، تنظیمات پیامک و گزارشها را میخواند؛ مقدار email_marketing.manage آنها را ایجاد کرده و تغییر میدهد. کمپینهایی که از طریق سرویس ایمیل اختصاصی خود ارسال میکنید از campaigns.view و campaigns.manage استفاده میکنند.
- نمایندگان فروش. برای انجام عملیات روی یکی از سازمانهای مشتریان خود،
org_id را ارسال کنید. زمانی که کلید یا اتصال شما دقیقاً به یک سازمان دسترسی دارد، از ارسال آن صرفنظر کنید.
نمونه: ایجاد پیشنویس یک کمپین با استفاده از API
curl -X POST https://api.zinndigital.com/v1/email-marketing/campaigns \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{
"name": "Spring sale",
"subject": "Our spring sale starts today",
"list_id": "<list id>",
"sender_id": "<sender id>",
"template": "basic"
}'
پاسخ 201 به همراه پیشنویس است. آن را با POST /v1/email-marketing/campaigns/{campaign_id}/test آزمایش کنید، با GET /v1/email-marketing/campaigns/{campaign_id}/lint بررسی کنید و با POST /v1/email-marketing/campaigns/{campaign_id}/send ارسال نمایید.
مثال: همان پیشنویس از یک دستیار هوش مصنوعی
از دستیار خود با کلمات ساده درخواست کنید، برای مثال: «یک پیشنویس ایمیل در Zinn® Campaigns به نام حراج بهاره با موضوع 'حراج بهاره ما از امروز آغاز میشود' ایجاد کن». در پشت صحنه، عملیات را با api_operations_search پیدا میکند، پارامترهای آن را با api_operation_get میخواند و آن را با api_operation_call اجرا میکند:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "api_operation_call",
"arguments": {
"operation_id": "createEmailMarketingCampaign",
"confirm": true,
"body": {
"name": "Spring sale",
"subject": "Our spring sale starts today"
}
}
}
}
کارهایی که یک دستیار انجام نخواهد داد. هر اقدامی که به دریافتکنندگان شما پیام ارسال کند یا هزینه یا سهمیهای مصرف نماید — ارسال کمپین، ارسال پیامهای SMS یا WhatsApp، نوشتن با اعتبارات AI، ثبتنام برای ارسال پیامک در US — برای دستیار مسدود میشود، تا یک دستور اشتباه فهمیدهشده هرگز نتواند به دست مشتریان شما برسد. دستیار پیشنویس را آماده میکند؛ شما در داشبورد دکمه ارسال را فشار میدهید یا خودتان API را فراخوانی میکنید. اطلاعات محرمانه مانند گذرواژه SMTP نیز هرگز از طریق دستیار انتقال نمییابند: آنها را در داشبورد وارد کنید.
محدودیتها
- ۱,۲۰۰ درخواست در دقیقه برای هر فرد یا کلید API، و ۶,۰۰۰ درخواست در دقیقه برای هر سازمان. محدودیت سختگیرانهتر از میان این دو اعمال میشود.
- ۶۰۰ درخواست در دقیقه برای هر اتصال MCP.
- در صورت عبور از محدودیت، پاسخ
429 همراه با هدر Retry-After است: به همان تعداد ثانیه منتظر بمانید.
- افزودن اعضای فهرست حداکثر ۱,۰۰۰ آدرس در هر درخواست میپذیرد؛ سهمیههای مخاطبان و ایمیل طرح شما برای تمام کارهایی که از طریق API انجام میدهید اعمال میشود.
خطاها
هر خطا ساختار یکسانی دارد:
{"error": {"code": "UNPROCESSABLE_ENTITY", "message": "…", "details": [{"field": "subject", "code": "REQUIRED", "message": "…"}], "request_id": "…"}}
مقدار code هرگز برای یک مشکل یکسان تغییر نمیکند، بنابراین به جای message آن را بررسی کنید. هنگام تماس با پشتیبانی، request_id را ذکر نمایید. پاسخهایی که با آنها مواجه خواهید شد: 401 UNAUTHORIZED، 403 FORBIDDEN، 404 NOT_FOUND، 409 CONFLICT، 422 UNPROCESSABLE_ENTITY، 429 TOO_MANY_REQUESTS. خطای 403 به این معنی است که کلید یا اتصال فاقد مجوزی است که در فهرست زیر ذکر شده است؛ خطای 404 همچنین موردی را در سازمانی که قادر به مشاهده آن نیستید پوشش میدهد؛ خطای 422 هر فیلد نادرست را در details فهرست میکند؛ پس از دریافت 429، به تعداد ثانیههای مشخصشده در هدر Retry-After منتظر بمانید.
وبهوکها
نتایج تحویل به Zinn® Campaigns از سوی ارائهدهندهای که ایمیل شما را ارسال میکند وارد میشود:
- با ارائهدهنده خودتان (برای مثال Resend)، کلید مخفی امضای وبهوک آن را در اتصال ارسال در پیشخوان ذخیره کنید (کمپینها ← ارسال). شما یک
webhook_url دریافت میکنید؛ رویدادهای تحویلشده، برگشتخورده و شکایت ارائهدهنده را به سمت آن هدایت نمایید. یک برگشت یا شکایت هرزنامه، بلافاصله نشانی را از ارسالهای بعدی حذف میکند.
- با ارسال Zinn®، نیازی به راهاندازی هیچ موردی نیست.
نتایج را با عملیاتهای گزارش بررسی کنید (getEmailMarketingCampaignReport، getSmsMarketingCampaignReport).
تمام عملیاتهای Campaigns
نمای کلی
GET /v1/email-marketing — نمای کلی Zinn® Campaigns برای یک سازمان. عملیات getEmailMarketingOverview. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
کمپینهای ایمیلی
GET /v1/email-marketing/campaigns — کمپینهای ایمیل، جدیدترینها در ابتدا، یک صفحه keyset. عملیات listEmailMarketingCampaigns. مجوزهای بررسیشده: email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/campaigns — ایجاد پیشنویس کمپین ایمیل. عملیات createEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/campaigns/{campaign_id} — یک کمپین ایمیل. عملیات getEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
PATCH /v1/email-marketing/campaigns/{campaign_id} — ویرایش یک پیشنویس (یا کمپین ردشده، که به پیشنویس بازمیگردد). عملیات updateEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/lint — بررسی متن کمپین از نظر مشکلات تحویلپذیری قبل از ارسال آن. عملیات lintEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/report — آمار و ارقام یک کمپین. عملیات getEmailMarketingCampaignReport. مجوزهای بررسیشده: email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/send — شروع ارسال کمپین به فهرست آن. عملیات sendEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف دستیار هوش مصنوعی: فقط API و پیشخوان: این عمل مستلزم صرف هزینه یا کسر سهمیه است، بنابراین باید توسط یک شخص فشرده شود (به گیرندگان واقعی ارسال میکند و سهمیه را مصرف مینماید).
POST /v1/email-marketing/campaigns/{campaign_id}/test — ارسال فوری یک نسخه آزمایشی برای یکی از اعضای سازمان. عملیات testEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/campaigns/{campaign_id}/translate — ترجمه کمپین به تمام زبانهای مخاطبانی که وجود ندارند یا قدیمی شدهاند. عملیات translateEmailMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/campaigns/{campaign_id}/translations — تمام زبانهای مخاطبان در فهرست یک کمپین و وضعیت بهروز بودن ترجمه آنها. عملیات listEmailMarketingCampaignTranslations. مجوزهای بررسیشده: email_marketing.view. از طرف دستیار هوش مصنوعی: بله، از طریق MCP.
نگارش با هوش مصنوعی
POST /v1/email-marketing/ai/write — نگارش پیشنویس ایمیل کمپین بر اساس یک خلاصه کوتاه با Zinn® AI. عملیات writeEmailMarketingCampaignWithAi. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از یک دستیار هوش مصنوعی: فقط API و داشبورد: این کار مستلزم هزینه یا مصرف سهمیه است، بنابراین یک شخص باید آن را فشار دهد (نگارش با هوش مصنوعی اعتبار هوش مصنوعی مصرف میکند).
کیت برند
GET /v1/email-marketing/brand-kit — کیت برند سازمان (نام، لوگو، رنگها، فونت، لحن بیان). عملیات getEmailMarketingBrandKit. مجوزهای بررسیشده: email_marketing.view. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
PUT /v1/email-marketing/brand-kit — ویرایش کیت برند. عملیات updateEmailMarketingBrandKit. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/brand-kit/read — خواندن کیت برند از وبسایت سازمان. عملیات readEmailMarketingBrandKit. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
مخاطبان و پیامهای یکباره
GET /v1/email-marketing/contacts — مخاطبین سازمان، هر بار یک صفحه keyset. عملیات listEmailMarketingContacts. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/contacts/{contact_id}/messages — ارسال یک پیامک به یک مخاطب، پرداختشده از موجودی اعتبار Zinn®. عملیات sendEmailMarketingMessage. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: فقط API و داشبورد: این کار مستلزم هزینه یا مصرف سهمیه است، بنابراین یک فرد باید آن را فشار دهد (یک پیام یکباره به یک مخاطب از سهمیه مصرف میکند).
GET /v1/email-marketing/messages — پیامهای پیامک و واتساپ ارسالشده توسط سازمان، ابتدا جدیدترینها، یک صفحه keyset. عملیات listEmailMarketingMessages. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
فهرستها
GET /v1/email-marketing/lists — لیستهای ایمیل سازمان به همراه تعداد اعضای عضو شده / لغو عضویت کرده. عملیات listEmailMarketingLists. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/lists — ایجاد یک لیست ایمیل (یا بازگرداندن موردی با همان نام). عملیات createEmailMarketingList. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/lists/{list_id}/members — افزودن مخاطبین به یک لیست از طریق نشانی ایمیل (حداکثر ۱٬۰۰۰ مورد در هر درخواست). عملیات addEmailMarketingListMembers. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
وارد کردنها
GET /v1/email-marketing/imports — وارد کردنهای پیشین مخاطبین، جدیدترینها در ابتدا، هر بار یک صفحه keyset. عملیات listEmailMarketingImports. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/imports — وارد کردن یک بخش از مخاطبین به همراه تأییدیه رضایت آن. عملیات createEmailMarketingImport. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
فرمهای ثبتنام
GET /v1/email-marketing/forms — فرمهای ثبتنام (تأیید دو مرحلهای)، جدیدترینها در ابتدا، یک صفحه keyset. عملیات listEmailMarketingForms. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/forms — ایجاد یک فرم ثبتنام که افراد تأییدشده را به یک فهرست اضافه میکند. عملیات createEmailMarketingForm. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
DELETE /v1/email-marketing/forms/{form_id} — حذف یک فرم ثبتنام (افرادی که قبلاً تأیید شدهاند در فهرست باقی میمانند). عملیات deleteEmailMarketingForm. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
PATCH /v1/email-marketing/forms/{form_id} — تغییر یک فرم ثبتنام (متن، فهرست، تغییر مسیر، روشن یا خاموش). عملیات updateEmailMarketingForm. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
اتصالات ارسال
GET /v1/email-marketing/senders — اتصالات ارسال سازمان. عملیات listEmailMarketingSenders. مجوزهای بررسیشده: email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/senders — اتصال یک فرستنده کارزار (ارسال Zinn® یا سرور SMTP اختصاصی مشتری). عملیات createEmailMarketingSender. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: فقط API و پیشخوان: حاوی رمزی است که هرگز نباید به دست مدل هوش مصنوعی برسد (بدنه همان گذرواژه SMTP است).
DELETE /v1/email-marketing/senders/{sender_id} — حذف یک اتصال ارسال و گذرواژه ذخیرهشده آن. عملیات deleteEmailMarketingSender. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/senders/{sender_id}/verify — اثبات عملکرد صحیح یک اتصال ارسال، بدون ارسال هرگونه پیام. عملیات verifyEmailMarketingSender. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
PUT /v1/email-marketing/senders/{sender_id}/webhook — ذخیره کلید مخفی امضای وبهوک ارائهدهنده ایمیل شما برای این اتصال. عملیات setEmailMarketingSenderWebhook. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: فراخوانیشده توسط سیستمی دیگر (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (کلید مخفی وبهوک یک ارائهدهنده را ذخیره میکند).
SMS و WhatsApp
GET /v1/email-marketing/sms — موارد مورد نیاز صفحه پیامک — باز است؟، متوقف شده است؟، موجودی اعتبار و قیمتها. عملیات getEmailMarketingSms. مجوزهای بررسیشده: email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/sms/campaigns — کمپینهای پیامک انبوه، جدیدترینها در ابتدا، یک صفحه keyset. عملیات listSmsMarketingCampaigns. مجوزهای بررسیشده: email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/sms/campaigns — ایجاد پیشنویس پیامک برای یک فهرست. عملیات createSmsMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id} — یک کمپین پیامک انبوه. عملیات getSmsMarketingCampaign. مجوزهای بررسیشده: email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — ویرایش یک پیشنویس (یا کمپین ردشده که به حالت پیشنویس بازمیگردد). عملیات updateSmsMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — آمار و ارقام یک کمپین پیامک انبوه. عملیات getSmsMarketingCampaignReport. مجوزهای بررسیشده: email_marketing.view. از دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — شروع ارسال پیامک به همه افراد موجود در فهرست آن که با دریافت پیامک موافقت کردهاند — یا ازسرگیری موردی که به دلیل اعتبار متوقف شده است. عملیات sendSmsMarketingCampaign. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق یک دستیار هوش مصنوعی: فقط API و پیشخوان: این عملیات هزینه یا سهمیه مصرف میکند، بنابراین باید توسط یک فرد فشرده شود (پیامهای پولی SMS/WhatsApp ارسال میکند).
GET /v1/email-marketing/sms/registrations/us — ثبتنام US 10DLC این سازمان و هزینه آن. عملیات getEmailMarketingUsRegistration. مجوزهای بررسیشده: email_marketing.view. از طریق یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/sms/registrations/us — ارسال برند و کمپین این سازمان برای US 10DLC (هزینه در زمان ثبت کسر میشود). عملیات submitEmailMarketingUsRegistration. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق یک دستیار هوش مصنوعی: فقط API و پیشخوان: این عملیات هزینه یا سهمیه مصرف میکند، بنابراین باید توسط یک فرد فشرده شود (ثبتنام US 10DLC مشمول هزینههای اپراتور است).
کمپینها از طریق سرویس ایمیل اختصاصی شما (الگوها، بخشها، فهرستهای سرکوب)
GET /v1/campaigns — کمپینهای سازمان. عملیات listCampaigns. از طریق یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns — ایجاد یک کمپین از روی یک الگو و یک مخاطب. عملیات createCampaign. از طریق یک دستیار هوش مصنوعی: بله، از طریق MCP.
DELETE /v1/campaigns/esp — حساب ارائهدهنده را قطع کرده و کلید ذخیرهشده آن را حذف کنید. عملیات disconnectEsp. از یک دستیار هوش مصنوعی: فقط API و داشبورد: حاوی رازی است که هرگز نباید به مدل هوش مصنوعی برسد (کلید ذخیرهشده ESP را از بین میبرد).
GET /v1/campaigns/esp — حساب ارائهدهنده ایمیل متعلق به سازمان. عملیات getEspConnection. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/esp — یک حساب ارائهدهنده ایمیل را متصل کنید. عملیات connectEsp. از یک دستیار هوش مصنوعی: فقط API و داشبورد: حاوی رازی است که هرگز نباید به مدل هوش مصنوعی برسد (بدنه، کلید API مربوط به ESP است).
POST /v1/campaigns/esp/verify — فعال بودن حساب ارائهدهنده را تأیید کرده و دامنههای تأییدشده آن را بخوانید. عملیات verifyEspConnection. از یک دستیار هوش مصنوعی: فقط API و داشبورد: حاوی رازی است که هرگز نباید به مدل هوش مصنوعی برسد (کلید ذخیرهشده ESP را مجدداً بررسی میکند).
POST /v1/campaigns/preview — مورد Render یک الگو با مقادیر نمونه. عملیات previewCampaignTemplate. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/segments — بخشهای مخاطبان ذخیرهشده شما. عملیات listCampaignSegments. مجوزهای بررسیشده: campaigns.view. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/segments — یک بخش جدید از مخاطبان را ذخیره کنید. عملیات createCampaignSegment. مجوزهای بررسیشده: campaigns.manage. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/segments/fields — واژگان فیلتر، فهرستهای مقادیر آن و برچسبهای جادویی. عملیات getCampaignSegmentFields. مجوزهای بررسیشده: campaigns.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/segments/preview — این مورد به دست چند نفر میرسد، آنها چه کسانی هستند و چه کسانی را شامل نمیشود. عملیات previewCampaignSegment. مجوزهای بررسیشده: campaigns.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
DELETE /v1/campaigns/segments/{segmentId} — بایگانی یک بخش. عملیات archiveCampaignSegment. مجوزهای بررسیشده: campaigns.manage. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/segments/{segmentId} — یک بخش ذخیرهشده. عملیات getCampaignSegment. مجوزهای بررسیشده: campaigns.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
PATCH /v1/campaigns/segments/{segmentId} — تغییر نام یک بخش یا ویرایش فیلترهای آن. عملیات updateCampaignSegment. مجوزهای بررسیشده: campaigns.manage. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/suppressions — نشانیهایی که نباید پیامهای بازاریابی دریافت کنند. عملیات listCampaignSuppressions. مجوزهای بررسیشده: campaigns.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/suppressions — افزودن یک نشانی به فهرست لغو ارسال. عملیات createCampaignSuppression. مجوزهای بررسیشده: campaigns.manage. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/tags — پالت برچسبهای جادویی که ویرایشگر کمپین ارائه میدهد. عملیات listCampaignTags. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/templates — الگوهای کمپین سازمان. عملیات listCampaignTemplates. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/templates — نگارش یک الگوی کمپین. عملیات createCampaignTemplate. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
DELETE /v1/campaigns/templates/{templateId} — بایگانی یک الگو و غیرفعال کردن منابع ترجمه آن. عملیات archiveCampaignTemplate. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/campaigns/templates/{templateId} — یک الگوی کمپین. عملیات getCampaignTemplate. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
PUT /v1/campaigns/templates/{templateId} — ویرایش یک الگوی کمپین. عملیات updateCampaignTemplate. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/unsubscribe — خروج از فهرست بازاریابی. بدون نیاز به حساب کاربری. عملیات unsubscribeFromCampaigns. از طریق دستیار هوش مصنوعی: فقط API و پیشخوان: حامل رازی است که هرگز نباید به مدل هوش مصنوعی برسد (یک توکن امضاشده لغو اشتراک گیرنده را میگیرد).
DELETE /v1/campaigns/{campaignId} — حذف یک کمپین و بازنشانی ردیفهای تحویل آن. عملیات deleteCampaign. از طریق دستیار هوش مصنوعی: فقط API و پیشخوان: به مجوزی نیاز دارد که به اتصالات هوش مصنوعی ارائه نمیشود (حذف کمپین ESP به campaigns.send نیاز دارد).
GET /v1/campaigns/{campaignId} — یک کمپین و گزارش تحویل آن. عملیات getCampaign. از یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/campaigns/{campaignId}/control — متوقف کردن موقت، ازسرگیری یا لغو یک ارسال در حال اجرا. عملیات controlCampaign. از یک دستیار هوش مصنوعی: فقط API و پیشخوان: هزینه مالی یا سهمیه مصرف میکند، بنابراین یک شخص باید آن را فشار دهد (ارسال زنده را متوقف میکند/از سر میگیرد).
POST /v1/campaigns/{campaignId}/send — شروع ارسال پایدار. عملیات sendCampaign. از یک دستیار هوش مصنوعی: فقط API و پیشخوان: هزینه مالی یا سهمیه مصرف میکند، بنابراین یک شخص باید آن را فشار دهد (یک کمپین ESP را برای گیرندگان واقعی ارسال میکند).
POST /v1/campaigns/{campaignId}/test — ارسال یک پیام واقعی در کانالی که کمپین واقعاً استفاده خواهد کرد. عملیات testSendCampaign. از یک دستیار هوش مصنوعی: فقط API و پیشخوان: به مجوزی نیاز دارد که به اتصالات هوش مصنوعی ارائه نمیشود (یک ارسال آزمایشی ESP به campaigns.send نیاز دارد).
صفحههای عمومی و وبهوکهای ورودی
GET /v1/public/email-marketing/c/{token} — شمارنده کلیک. یک کلیک به ازای هر گیرنده ثبت میکند و به پیوند اصلی تغییر مسیر میدهد. عملیات emailMarketingClick. از یک دستیار هوش مصنوعی: صفحهای که گیرندگان شما از یک ایمیل باز میکنند (تغییر مسیر ردیابی کلیک).
GET /v1/public/email-marketing/f/{public_id} — صفحه میزبانیشده یک فرم ثبتنام (بدون نیاز به ورود). عملیات emailMarketingFormPage. از یک دستیار هوش مصنوعی: صفحهای که گیرندگان شما از یک ایمیل باز میکنند (صفحه عمومی فرم ثبتنام).
POST /v1/public/email-marketing/f/{public_id} — ارسال فرم ثبتنام (صفحه میزبانیشده، جاسازیشده یا JSON). عملیات emailMarketingFormSubmit. از طرف یک دستیار هوش مصنوعی: توسط سیستم دیگری (یک ارائهدهنده یا یک بازدیدکننده) فراخوانی میشود، نه توسط شما (یک بازدیدکننده فرم ثبتنام را ارسال میکند).
GET /v1/public/email-marketing/fc — صفحه تأیید عضویت دو مرحلهای (بدون نیاز به ورود به سیستم). عملیات emailMarketingFormConfirmPage. از طرف یک دستیار هوش مصنوعی: صفحهای که گیرندگان شما از طریق یک ایمیل باز میکنند (صفحه تأیید عضویت دو مرحلهای).
POST /v1/public/email-marketing/fc — تأیید ثبتنام (افزودن فرد به فهرست همراه با ثبت رضایت). عملیات emailMarketingFormConfirm. از طرف یک دستیار هوش مصنوعی: توسط سیستم دیگری (یک ارائهدهنده یا یک بازدیدکننده) فراخوانی میشود، نه توسط شما (یک بازدیدکننده عضویت دو مرحلهای را تأیید میکند).
GET /v1/public/email-marketing/o/{token} — تصویر ردیابی باز شدن ایمیل (یک فایل GIF در ابعاد ۱x۱). یک باز شدن به ازای هر گیرنده محاسبه میشود. عملیات emailMarketingOpenPixel. از طرف یک دستیار هوش مصنوعی: صفحهای که گیرندگان شما از طریق یک ایمیل باز میکنند (پیکسل ردیابی باز شدن ایمیل).
GET /v1/public/email-marketing/u/{token} — پیوند لغو اشتراک در پاورقی (بدون نیاز به ورود به سیستم). عملیات emailMarketingUnsubscribePage. از طرف یک دستیار هوش مصنوعی: صفحهای که گیرندگان شما از طریق یک ایمیل باز میکنند (صفحه لغو اشتراک).
POST /v1/public/email-marketing/u/{token} — لغو اشتراک با یک کلیک بر اساس RFC 8058 (و دکمه «توقف همه چیز» صفحه). عملیات emailMarketingUnsubscribeOneClick. از یک دستیار هوش مصنوعی: توسط سیستم دیگری فراخوانی میشود (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (لغو اشتراک با یک کلیک بر اساس RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — پیوند لغو اشتراک ایمیل گرمسازی مخزن بازاریابی (بدون نیاز به ورود). عملیات emailMarketingWarmupUnsubscribePage. از یک دستیار هوش مصنوعی: صفحهای که دریافتکنندگان شما از طریق یک ایمیل باز میکنند (صفحه لغو اشتراک گرمسازی).
POST /v1/public/email-marketing/warmup-u/{token} — لغو اشتراک با یک کلیک بر اساس RFC 8058 از ایمیل گرمسازی. عملیات emailMarketingWarmupUnsubscribeOneClick. از یک دستیار هوش مصنوعی: توسط سیستم دیگری فراخوانی میشود (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (لغو اشتراک گرمسازی با یک کلیک).
POST /v1/webhooks/campaign-events — دریافت یک رویداد تحویل امضاشده از ارائهدهنده ایمیل. عملیات receiveCampaignDeliveryWebhook. از یک دستیار هوش مصنوعی: توسط سیستم دیگری فراخوانی میشود (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (وبهوک تحویل امضاشده ESP).
POST /v1/webhooks/campaigns/telnyx — پاسخهای پیامکی ورودی (STOP / START) از ارائهدهنده پیامک ما. عملیات receiveCampaignsTelnyxInbound. از یک دستیار هوش مصنوعی: توسط سیستم دیگری فراخوانی میشود (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (وبهوک ورودی امضاشده Telnyx).
POST /v1/webhooks/email-marketing/{connection_id} — رویدادهای تحویل ارائهدهنده ایمیل خود مشتری برای یک اتصال ارسال. عملیات receiveEmailMarketingProviderWebhook. از طرف یک دستیار هوش مصنوعی: فراخوانیشده توسط سیستمی دیگر (یک ارائهدهنده یا یک بازدیدکننده)، نه توسط شما (وبهوک امضاشده ارائهدهنده-فرستنده).
جریانها
GET /v1/email-marketing/flows — جریانهای ایمیل (خوشآمدگویی، قطرهای، یک تاریخ سالانه)، یک صفحه کلیدمجموعه (keyset). عملیات listEmailMarketingFlows. مجوزهای بررسیشده: email_marketing.view. از طرف یک دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/flows — ایجاد یک جریان (بهعنوان پیشنویس شروع میشود). عملیات createEmailMarketingFlow. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف یک دستیار هوش مصنوعی: بله، از طریق MCP.
DELETE /v1/email-marketing/flows/{flow_id} — حذف یک جریان و ثبتنامهای آن (اجراهای ارسالشده آن، بهعنوان کمپین باقی میمانند). عملیات deleteEmailMarketingFlow. مجوزهای بررسیشده: email_marketing.manage، email_marketing.view. از طرف یک دستیار هوش مصنوعی: بله، از طریق MCP.
GET /v1/email-marketing/flows/{flow_id} — یک جریان با مراحل و گزارش آن (ثبتنامشده، در حال انجام، اجراها و گیرندگان به ازای هر مرحله). عملیات getEmailMarketingFlow. مجوزهای بررسیشده: email_marketing.view. از طرف یک دستیار هوش مصنوعی: بله، از طریق MCP.
PATCH /v1/email-marketing/flows/{flow_id} — تغییر یک جریان؛ پارامتر steps در صورت ارائه، جایگزین کل توالی میشود. عملیات updateEmailMarketingFlow. دسترسیهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/flows/{flow_id}/activate — فعال کردن یک جریان؛ فقط افرادی که از این پس به فهرست بپیوندند ثبتنام میشوند. عملیات activateEmailMarketingFlow. دسترسیهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.
POST /v1/email-marketing/flows/{flow_id}/pause — متوقف کردن موقت یک جریان؛ مراحل سررسیدشده منتظر میمانند و تا زمان فعالسازی مجدد، هیچ ایمیلی به افراد جدید ارسال نمیشود. عملیات pauseEmailMarketingFlow. دسترسیهای بررسیشده: email_marketing.manage، email_marketing.view. از طریق دستیار هوش مصنوعی: بله، از طریق MCP.