Zinn® Campaigns API এবং MCP: ডেভেলপার নির্দেশিকা

ড্যাশবোর্ডে Zinn® Campaigns-এ আপনি যা কিছু করতে পারেন, তার সবকিছুই API-এর মাধ্যমেও করতে পারেন, এবং এর বেশিরভাগই MCP-এর মাধ্যমে আপনার অ্যাকাউন্টের সাথে যুক্ত একটি AI সহকারীর মাধ্যমে করা সম্ভব। এই নির্দেশিকায় সাইন ইন করা, অনুমতিসমূহ, উভয় পদ্ধতির একটি কার্যকর উদাহরণ, সীমাবদ্ধতাসমূহ, ত্রুটিসমূহ এবং Campaigns-এর ৮৯টি অপারেশনের প্রতিটি অন্তর্ভুক্ত রয়েছে। নিচের অপারেশনের তালিকাটি আমাদের API স্পেসিফিকেশন থেকে তৈরি করা হয়েছে, তাই API যা করে এটি সর্বদা তার সাথে হুবহু মিলে যায়। প্রতিটি অপারেশনের প্রতিটি ক্ষেত্র zinndigital.com/developers/api/zinn-campaigns-এ API রেফারেন্সে রয়েছে।

সাইন ইন করা

• API কী। ড্যাশবোর্ডে সেটিংস → API কী-এর অধীনে একটি কী তৈরি করুন এবং এটিকে Authorization: Bearer zdk_live_… হিসেবে পাঠান (একটি zdk_test_… কী স্যান্ডবক্স মোডে কাজ করে)। কী-টিতে শুধুমাত্র প্রয়োজনীয় Campaigns অনুমতি দিন এবং অতিরিক্ত কিছু দেবেন না।
• AI সহকারী (MCP)। অ্যাপ থেকে সাইন ইন করে অথবা সংযোগ টোকেন (zmcp_live_…) ব্যবহার করে Claude, ChatGPT, Cursor বা যেকোনো MCP ক্লায়েন্টকে https://api.zinndigital.com/v1/mcp-এর সাথে সংযুক্ত করুন। আপনার অ্যাকাউন্টে Claude, Cursor বা ChatGPT সংযুক্ত করা দেখুন। সম্মতি স্ক্রিনে, Zinn® Campaigns অনুমতিগুলোতে টিক দিন।
• অনুমতি। email_marketing.view ক্যাম্পেন, তালিকা, পরিচিতি, ফর্ম, প্রেরক, SMS সেটিংস এবং রিপোর্ট পড়তে পারে; 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 সংযোগের জন্য মিনিটে ৬০০টি অনুরোধ।
• সীমা অতিক্রম করলে, একটি Retry-After হেডার সহ উত্তর হবে 429: ঠিক তত সেকেন্ড অপেক্ষা করুন।
• তালিকায় সদস্য যোগ করতে প্রতি অনুরোধে সর্বাধিক ১,০০০টি ঠিকানা নেওয়া যায়; আপনি 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 হেডারে উল্লেখিত সেকেন্ডের সংখ্যা পর্যন্ত অপেক্ষা করুন।

Webhooks

বিতরণের ফলাফল আপনার ইমেল প্রেরণকারী প্রদানকারীর কাছ থেকে Zinn® Campaigns-এর ভেতরে আসে:

• আপনার নিজস্ব প্রদানকারীর ক্ষেত্রে (উদাহরণস্বরূপ Resend), ড্যাশবোর্ডে প্রেরণের সংযোগে এর ওয়েবহুক সাইনিং সিক্রেট সংরক্ষণ করুন (Campaigns → Sending)। আপনি একটি webhook_url পাবেন; প্রদানকারীর ডেলিভার্ড, বাউন্সড এবং কমপ্লেইনড ইভেন্টগুলিকে এটির দিকে নির্দেশ করুন। একটি বাউন্স বা স্প্যাম অভিযোগ ঠিকানাটিকে ভবিষ্যতের প্রেরণ থেকে অবিলম্বে সরিয়ে দেয়।
• Zinn® প্রেরণের সাথে সেট আপ করার মতো কিছু নেই।

রিপোর্ট অপারেশনগুলি দিয়ে ফলাফলগুলি পড়ুন (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport)।

প্রতিটি Campaigns অপারেশন

ওভারভিউ

• GET /v1/email-marketing — একটি সংস্থার জন্য Zinn® Campaigns ওভারভিউ। অপারেশন getEmailMarketingOverview। পরীক্ষিত অনুমতিসমূহ: email_marketing.view। একটি এআই সহায়কের কাছ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।

ইমেল ক্যাম্পেইনসমূহ

• GET /v1/email-marketing/campaigns — ইমেল ক্যাম্পেইন, নতুনগুলো প্রথমে, একটি কী-সেট পৃষ্ঠা। অপারেশন 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। কোনো AI সহকারী থেকে: শুধুমাত্র API এবং ড্যাশবোর্ড: এটি অর্থ বা বরাদ্দ খরচ করে, তাই কোনো ব্যক্তি এটি চাপবেন (প্রকৃত প্রাপকদের কাছে পাঠায় এবং বরাদ্দ খরচ করে)।
• POST /v1/email-marketing/campaigns/{campaign_id}/test — সংস্থার একজন সদস্যকে এখনই একটি পরীক্ষামূলক অনুলিপি পাঠান। অপারেশন testEmailMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/campaigns/{campaign_id}/translate — কোনো ক্যাম্পেইনকে প্রতিটি অনুপস্থিত বা পুরনো যোগাযোগের ভাষায় অনুবাদ করুন। অপারেশন translateEmailMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/email-marketing/campaigns/{campaign_id}/translations — একটি ক্যাম্পেইনের তালিকার প্রতিটি যোগাযোগের ভাষা এবং এর অনুবাদটি হালনাগাদ রয়েছে কি না। অপারেশন listEmailMarketingCampaignTranslations। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।

AI দিয়ে লেখা

• POST /v1/email-marketing/ai/write — Zinn® AI দিয়ে একটি সংক্ষিপ্ত বিবরণ থেকে খসড়া ক্যাম্পেইন ইমেল লিখুন। অপারেশন writeEmailMarketingCampaignWithAi। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: শুধুমাত্র API এবং ড্যাশবোর্ড: এটি অর্থ বা বরাদ্দ খরচ করে, তাই একজন ব্যক্তি এটি চাপেন (AI লিখন AI ক্রেডিট খরচ করে)।

ব্র্যান্ড কিট

• GET /v1/email-marketing/brand-kit — প্রতিষ্ঠানের ব্র্যান্ড কিট (নাম, লোগো, রং, ফন্ট, স্বরভঙ্গি)। অপারেশন getEmailMarketingBrandKit। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• PUT /v1/email-marketing/brand-kit — ব্র্যান্ড কিট সম্পাদনা করুন। অপারেশন updateEmailMarketingBrandKit। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/brand-kit/read — প্রতিষ্ঠানের ওয়েবসাইট থেকে ব্র্যান্ড কিট পড়ুন। অপারেশন readEmailMarketingBrandKit। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।

পরিচিতি এবং এককালীন বার্তাসমূহ

• GET /v1/email-marketing/contacts — সংস্থার পরিচিতিগুলি, প্রতিবারে একটি কি-সেট পেজ। অপারেশন 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 — সংস্থার পাঠানো এসএমএস এবং WhatsApp বার্তাসমূহ, নতুনগুলি প্রথমে, একটি কি-সেট পেজ। অপারেশন listEmailMarketingMessages। অনুমতি যাচাই করা হয়েছে: email_marketing.view। এআই অ্যাসিস্ট্যান্ট থেকে: হ্যাঁ, MCP-এর মাধ্যমে।

তালিকাসমূহ

• GET /v1/email-marketing/lists — সাবস্ক্রাইব করা / আনসাবস্ক্রাইব করা সংখ্যা সহ সংস্থার মেলিং তালিকা। অপারেশন listEmailMarketingLists। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/lists — একটি মেলিং তালিকা তৈরি করুন (অথবা সেই নামের তালিকাটি ফেরত দিন)। অপারেশন createEmailMarketingList। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/lists/{list_id}/members — ইমেল ঠিকানার মাধ্যমে তালিকায় পরিচিতি যোগ করুন (অনুরোধ প্রতি সর্বোচ্চ ১,০০০টি)। অপারেশন addEmailMarketingListMembers। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।

ইমপোর্টসমূহ

• GET /v1/email-marketing/imports — অতীতের পরিচিতি ইমপোর্টসমূহ, নতুনগুলি প্রথমে, প্রতিবারে একটি keyset পৃষ্ঠা। অপারেশন listEmailMarketingImports। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/imports — সম্মতির প্রমাণীকরণ সহ পরিচিতির একটি অংশ ইমপোর্ট করুন। অপারেশন createEmailMarketingImport। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। AI সহকারী থেকে: হ্যাঁ, 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 — SMS স্ক্রিনের যা প্রয়োজন — উন্মুক্ত?, স্থগিত?, ক্রেডিট ব্যালেন্স এবং মূল্য। অপারেশন getEmailMarketingSms। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/email-marketing/sms/campaigns — বাল্ক SMS ক্যাম্পেইনসমূহ, নতুনগুলো প্রথমে, একটি keyset পৃষ্ঠা। অপারেশন listSmsMarketingCampaigns। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/sms/campaigns — একটি তালিকার জন্য খসড়া SMS তৈরি করুন। অপারেশন createSmsMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — একটি বাল্ক SMS ক্যাম্পেইন। অপারেশন getSmsMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• PATCH /v1/email-marketing/sms/campaigns/{campaign_id} — একটি খসড়া সম্পাদনা করুন (অথবা একটি প্রত্যাখ্যাত ক্যাম্পেইন, যা খসড়ায় ফিরে যায়)। অপারেশন updateSmsMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/email-marketing/sms/campaigns/{campaign_id}/report — একটি বাল্ক SMS ক্যাম্পেইনের পরিসংখ্যান। অপারেশন getSmsMarketingCampaignReport। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। কোনো AI সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/sms/campaigns/{campaign_id}/send — তালিকায় থাকা এবং SMS পেতে সম্মত হয়েছেন এমন সবাইকে একটি SMS পাঠানো শুরু করুন — অথবা ক্রেডিটের কারণে স্থগিত থাকা একটি প্রচার পুনরায় চালু করুন। অপারেশন sendSmsMarketingCampaign। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। AI সহকারীর পক্ষ থেকে: কেবল API এবং ড্যাশবোর্ডের মাধ্যমে: এটি অর্থ বা বরাদ্দ খরচ করে, তাই কোনও ব্যক্তি এটিতে চাপ দেন (পেইড SMS/WhatsApp বার্তা পাঠায়)।
• GET /v1/email-marketing/sms/registrations/us — এই সংস্থার US 10DLC নিবন্ধন, এবং প্রতিটির খরচ কত। অপারেশন getEmailMarketingUsRegistration। যাচাইকৃত অনুমতিসমূহ: email_marketing.view। AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/sms/registrations/us — US 10DLC-এর জন্য এই সংস্থার ব্র্যান্ড এবং প্রচার জমা দিন (জমা দেওয়ার সময় চার্জ করা হয়)। অপারেশন submitEmailMarketingUsRegistration। যাচাইকৃত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। AI সহকারীর পক্ষ থেকে: কেবল API এবং ড্যাশবোর্ডের মাধ্যমে: এটি অর্থ বা বরাদ্দ খরচ করে, তাই কোনও ব্যক্তি এটিতে চাপ দেন (US 10DLC নিবন্ধনে ক্যারিয়ার ফি প্রযোজ্য)।

আপনার নিজস্ব ইমেল পরিষেবার মাধ্যমে প্রচার (টেমপ্লেট, সেগমেন্ট, সাপ্রেশন)

• GET /v1/campaigns — সংস্থার প্রচারসমূহ। অপারেশন listCampaigns। AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/campaigns — একটি টেমপ্লেট এবং দর্শকশ্রেণী থেকে একটি প্রচার তৈরি করুন। অপারেশন createCampaign। AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• DELETE /v1/campaigns/esp — প্রদানকারী অ্যাকাউন্টটি সংযোগ বিচ্ছিন্ন করুন এবং এর সংরক্ষিত কী সরিয়ে ফেলুন। অপারেশন disconnectEsp। একজন এআই সহকারী থেকে: শুধুমাত্র এপিআই এবং ড্যাশবোর্ড: এতে এমন একটি গোপনীয় তথ্য রয়েছে যা কখনোই কোনো এআই মডেলে পৌঁছানো উচিত নয় (সংরক্ষিত ESP কী ধ্বংস করে)।
• GET /v1/campaigns/esp — সংস্থার নিজস্ব ইমেল প্রদানকারী অ্যাকাউন্ট। অপারেশন getEspConnection। একজন এআই সহকারী থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/campaigns/esp — একটি ইমেল প্রদানকারী অ্যাকাউন্ট সংযুক্ত করুন। অপারেশন connectEsp। একজন এআই সহকারী থেকে: শুধুমাত্র এপিআই এবং ড্যাশবোর্ড: এতে এমন একটি গোপনীয় তথ্য রয়েছে যা কখনোই কোনো এআই মডেলে পৌঁছানো উচিত নয় (বডিটি হলো ESP এপিআই কী)।
• POST /v1/campaigns/esp/verify — প্রদানকারী অ্যাকাউন্টটি কাজ করছে কিনা তা প্রমাণ করুন এবং এর যাচাইকৃত ডোমেনগুলি পড়ুন। অপারেশন verifyEspConnection। একজন এআই সহকারী থেকে: শুধুমাত্র এপিআই এবং ড্যাশবোর্ড: এতে এমন একটি গোপনীয় তথ্য রয়েছে যা কখনোই কোনো এআই মডেলে পৌঁছানো উচিত নয় (একটি সংরক্ষিত 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। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/campaigns/templates — সংস্থার ক্যাম্পেইন টেমপ্লেটগুলি। অপারেশন listCampaignTemplates। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/campaigns/templates — একটি ক্যাম্পেইন টেমপ্লেট তৈরি করুন। অপারেশন createCampaignTemplate। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• DELETE /v1/campaigns/templates/{templateId} — একটি টেমপ্লেট সংরক্ষণাগারে রাখুন এবং এর অনুবাদের উৎসগুলি প্রত্যাহার করুন। অপারেশন archiveCampaignTemplate। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• GET /v1/campaigns/templates/{templateId} — একটি ক্যাম্পেইন টেমপ্লেট। অপারেশন getCampaignTemplate। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• PUT /v1/campaigns/templates/{templateId} — একটি ক্যাম্পেইন টেমপ্লেট সম্পাদনা করুন। অপারেশন updateCampaignTemplate। কোনো AI সহায়কের মাধ্যমে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/campaigns/unsubscribe — একটি বিপণন তালিকা থেকে প্রস্থান করুন। কোনো অ্যাকাউন্টের প্রয়োজন নেই। অপারেশন unsubscribeFromCampaigns। কোনো AI সহায়কের মাধ্যমে: শুধুমাত্র API এবং ড্যাশবোর্ড: এটি এমন একটি গোপন তথ্য বহন করে যা কখনই কোনো AI মডেলে পৌঁছানো উচিত নয় (প্রাপকের স্বাক্ষরিত আনসাবস্ক্রাইব টোকেন গ্রহণ করে)।
• DELETE /v1/campaigns/{campaignId} — একটি ক্যাম্পেইন মুছুন এবং এর ডেলিভারি সারিগুলি প্রত্যাহার করুন। অপারেশন deleteCampaign। কোনো AI সহায়কের মাধ্যমে: শুধুমাত্র API এবং ড্যাশবোর্ড: এটির এমন একটি অনুমতির প্রয়োজন যা AI সংযোগগুলিতে অফার করা হয় না (একটি 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। একজন AI সহায়কের কাছ থেকে: আপনার দ্বারা নয়, অন্য একটি সিস্টেম (একজন প্রদানকারী বা একজন পরিদর্শক) দ্বারা কল করা হয়েছে (একজন পরিদর্শক একটি সাইন-আপ ফর্ম জমা দেন)।
• GET /v1/public/email-marketing/fc — ডাবল অপ্ট-ইন নিশ্চিতকরণ পৃষ্ঠা (কোনো লগইন প্রয়োজন নেই)। অপারেশন emailMarketingFormConfirmPage। একজন AI সহায়কের কাছ থেকে: আপনার প্রাপকরা একটি ইমেল থেকে যে পৃষ্ঠাটি খোলেন (ডাবল অপ্ট-ইন নিশ্চিতকরণ পৃষ্ঠা)।
• POST /v1/public/email-marketing/fc — একটি সাইন-আপ নিশ্চিত করুন (সম্মতির রেকর্ড সহ ব্যক্তিকে তালিকায় যুক্ত করে)। অপারেশন emailMarketingFormConfirm। একজন AI সহায়কের কাছ থেকে: আপনার দ্বারা নয়, অন্য একটি সিস্টেম (একজন প্রদানকারী বা একজন পরিদর্শক) দ্বারা কল করা হয়েছে (একজন পরিদর্শক একটি ডাবল অপ্ট-ইন নিশ্চিত করেন)।
• GET /v1/public/email-marketing/o/{token} — ওপেন-ট্র্যাকিং চিত্র (একটি 1x1 GIF)। প্রতি প্রাপকের জন্য একটি ওপেন গণনা করে। অপারেশন emailMarketingOpenPixel। একজন AI সহায়কের কাছ থেকে: আপনার প্রাপকরা একটি ইমেল থেকে যে পৃষ্ঠাটি খোলেন (ওপেন-ট্র্যাকিং পিক্সেল)।
• GET /v1/public/email-marketing/u/{token} — ফুটার আনসাবস্ক্রাইব লিঙ্ক (কোনো লগইন প্রয়োজন নেই)। অপারেশন emailMarketingUnsubscribePage। একজন AI সহায়কের কাছ থেকে: আপনার প্রাপকরা একটি ইমেল থেকে যে পৃষ্ঠাটি খোলেন (আনসাবস্ক্রাইব পৃষ্ঠা)।
• 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। এআই অ্যাসিস্ট্যান্ট থেকে: অন্য একটি সিস্টেম দ্বারা কল করা হয় (একজন প্রদানকারী বা একজন ভিজিটর), আপনার দ্বারা নয় (স্বাক্ষরিত প্রেরক-প্রদানকারী ওয়েবহুক)।

Flows

• GET /v1/email-marketing/flows — ইমেল ফ্লো (ওয়েলকাম, ড্রিপ, একটি বাৎসরিক তারিখ), একটি কীসেট পেজ। অপারেশন 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। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/flows/{flow_id}/activate — একটি ফ্লো চালু করুন; এখন থেকে তালিকায় যোগ দেওয়া ব্যক্তিরাই কেবল অন্তর্ভুক্ত হবেন। অপারেশন activateEmailMarketingFlow। পরীক্ষিত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।
• POST /v1/email-marketing/flows/{flow_id}/pause — একটি ফ্লো সাময়িকভাবে থামান; বকেয়া ধাপগুলো অপেক্ষায় থাকে এবং এটি পুনরায় চালু না করা পর্যন্ত নতুন কাউকে ইমেল পাঠানো হয় না। অপারেশন pauseEmailMarketingFlow। পরীক্ষিত অনুমতিসমূহ: email_marketing.manage, email_marketing.view। কোনো AI সহকারীর পক্ষ থেকে: হ্যাঁ, MCP-এর মাধ্যমে।