Zinn® Campaigns API ва MCP: дастури таҳиягар

Ҳама чизеро, ки Шумо метавонед дар панели идоракунӣ дар Zinn® Campaigns иҷро кунед, метавонед тавассути API низ анҷом диҳед, ва қисми зиёди онро аз ёвари зеҳни сунъӣ, ки тавассути MCP ба ҳисоби Шумо васл шудааст, иҷро кардан мумкин аст. Ин дастур воридшавӣ, иҷозатҳо, мисоли амалиро ба ҳар ду роҳ, маҳдудиятҳо, хатогиҳо ва ҳар яке аз 89 амалиёти Campaigns-ро дар бар мегирад. Рӯйхати амалиёти зерин аз мушаххасоти API-и мо таҳия шудааст, бинобар ин он ҳамеша ба кори API комилан мувофиқат мекунад. Ҳар як майдони ҳар як амалиёт дар маълумотномаи API дар zinndigital.com/developers/api/zinn-campaigns оварда шудааст.

Воридшавӣ

• Калидҳои API. Дар панели идоракунӣ дар зери Танзимотҳо → Калидҳои API калид созед ва онро ҳамчун Authorization: Bearer zdk_live_… фиристед (калиди zdk_test_… дар реҷаи санҷишӣ кор мекунад). Ба калид танҳо иҷозатҳои Campaigns-ро диҳед, ки ба он лозиманд ва на бештар аз ин.
• Ёварони AI (MCP). Claude, ChatGPT, Cursor ё ҳар як муштарии MCP-ро ба https://api.zinndigital.com/v1/mcp пайваст кунед, ё тавассути ворид шудан аз барнома ё бо нишонаи пайвастшавӣ (zmcp_live_…). Ба бахши Пайваст кардани 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-ро бо номи Spring sale ва бо мавзӯи 'Our spring sale starts today' омода кунед". Дар паси парда он амалиётро бо 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 дар як дақиқа 1,200 дархост, ва барои ҳар як ташкилот дар як дақиқа 6,000 дархост. Аз ин ду маҳдудияти сахттарин амал мекунад.
• Барои ҳар як пайвасти MCP дар як дақиқа 600 дархост.
• Ҳангоми гузаштан аз маҳдудият, ҷавоб 429 бо сарлавҳаи Retry-After мебошад: ҳамон қадар сония интизор шавед.
• Илова кардани аъзои рӯйхат дар як дархост ҳадди аксар 1,000 нишониро қабул мекунад; маҳдудиятҳои тамос ва почтаи электронии нақшаи шумо ба ҳама чизе, ки шумо тавассути 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), сирри имзои webhook-и онро дар пайвасти ирсолкунанда дар панели идоракунӣ (Маъракаҳо → Ирсолкунӣ) захира кунед. Шумо webhook_url-ро ба даст меоред; рӯйдодҳои расонидашуда, баргардонидашуда ва шикояткардаи таъминкунандаро ба он равона кунед. Баргардонидани паём ё шикояти спам суроғаро аз ирсолҳои оянда фавран нест мекунад.
• Ҳангоми ирсол бо Zinn®, чизе барои танзим кардан нест.

Натиҷаҳоро бо амалиёти гузоришҳо хонед (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).

Ҳар як амалиёти Маъракаҳо

Баррасии умумӣ

• GET /v1/email-marketing — Баррасии умумии Zinn® Campaigns барои як созмон. Амалиёти getEmailMarketingOverview. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари AI: ҳа, тавассути 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. Аз ёвари 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 — Тамосҳои созмон, як саҳифаи keyset дар як вақт. Амалиёти listEmailMarketingContacts. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари AI: ҳа, тавассути MCP.
• POST /v1/email-marketing/contacts/{contact_id}/messages — Як SMS ба як тамос фиристед, ки аз бақияи эътибори Zinn® пардохта мешавад. Амалиёти sendEmailMarketingMessage. Иҷозатҳои санҷидашуда: email_marketing.manage, email_marketing.view. Аз ёвари AI: танҳо API ва панели идоракунӣ: он пул ё меъёрро сарф мекунад, бинобар ин онро шахс пахш мекунад (паёми якдафъаина ба тамос меъёрро сарф мекунад).
• GET /v1/email-marketing/messages — Паёмҳои SMS ва WhatsApp, ки созмон фиристодааст, аввал навтаринҳо, як саҳифаи keyset. Амалиёти listEmailMarketingMessages. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари AI: ҳа, тавассути 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 — Тамосҳоро бо суроғаи почтаи электронӣ ба рӯйхат илова кунед (дар як дархост ҳадди аксар 1,000). Амалиёти 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 — Шаклҳои бақайдгирӣ (розигии дукарата), аввал навтаринҳо, як саҳифаи маҷмӯи калидҳо. Амалиёт 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 — Нигоҳ доштани сирри имзокунии webhook-и провайдери почтаи электронии худ барои ин пайваст. Амалиёти setEmailMarketingSenderWebhook. Иҷозатҳои санҷидашуда: email_marketing.manage, email_marketing.view. Аз ёвари зеҳни сунъӣ: аз ҷониби системаи дигар даъват карда мешавад (провайдер ё меҳмон), на аз ҷониби шумо (сирри webhook-и провайдерро нигоҳ медорад).

SMS ва WhatsApp

• GET /v1/email-marketing/sms — Он чӣ ба экрани SMS лозим аст — кушода аст?, таваққуф шудааст?, бақияи қарз ва нархҳо. Амалиёт getEmailMarketingSms. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари зеҳни сунъӣ: ҳа, тавассути MCP.
• GET /v1/email-marketing/sms/campaigns — Маъракаҳои оммавии SMS, аввал навтаринҳо, як саҳифаи keyset. Амалиёт listSmsMarketingCampaigns. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари зеҳни сунъӣ: ҳа, тавассути MCP.
• POST /v1/email-marketing/sms/campaigns — Эҷоди сиёҳнависи SMS барои рӯйхат. Амалиёт createSmsMarketingCampaign. Иҷозатҳои санҷидашуда: email_marketing.manage, email_marketing.view. Аз ёвари зеҳни сунъӣ: ҳа, тавассути MCP.
• GET /v1/email-marketing/sms/campaigns/{campaign_id} — Як маъракаи оммавии SMS. Амалиёт 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 — Рақамҳои омории маъракаи оммавии SMS. Амалиёт getSmsMarketingCampaignReport. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари зеҳни сунъӣ: ҳа, тавассути 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. Аз ёрдамчии зеҳни сунъӣ: танҳо 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. Аз ёвари 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. Аз ҷониби ёвари зеҳни сунъӣ: аз ҷониби системаи дигар даъват карда мешавад (таъминкунанда ё боздидкунанда), на аз ҷониби шумо (боздидкунанда шакли номнависиро ирсол мекунад).
• GET /v1/public/email-marketing/fc — Саҳифаи тасдиқи дукаратаи обуна (бе воридшавӣ). Амалиёти emailMarketingFormConfirmPage. Аз ҷониби ёвари зеҳни сунъӣ: саҳифае, ки қабулкунандагони шумо аз паёми электронӣ мекушоянд (саҳифаи тасдиқи дукаратаи обуна).
• POST /v1/public/email-marketing/fc — Тасдиқи номнависӣ (шахсро бо сабти ризоият ба рӯйхат илова мекунад). Амалиёти emailMarketingFormConfirm. Аз ҷониби ёвари зеҳни сунъӣ: аз ҷониби системаи дигар даъват карда мешавад (таъминкунанда ё боздидкунанда), на аз ҷониби шумо (боздидкунанда тасдиқи дукаратаи обунаро тасдиқ мекунад).
• GET /v1/public/email-marketing/o/{token} — Тасвири пайгирии кушодашавӣ (GIF-и 1х1). Барои ҳар як қабулкунанда як кушодашавиро ҳисоб мекунад. Амалиёти 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 — Ҷавобҳои воридотии SMS (STOP / START) аз фурӯшандаи SMS-и мо. Амалиёти receiveCampaignsTelnyxInbound. Аз ёвари зеҳни сунъӣ: аз ҷониби системаи дигар даъват шудааст (таъминкунанда ё меҳмон), на аз ҷониби шумо (вебҳуки имзошудаи воридотии Telnyx).
• POST /v1/webhooks/email-marketing/{connection_id} — Рӯйдодҳои интиқоли худи таъминкунандаи почтаи электронии муштарӣ барои як пайвасти ирсол. Амалиёти receiveEmailMarketingProviderWebhook. Аз ёвари AI: аз ҷониби системаи дигар даъват карда мешавад (таъминкунанда ё меҳмон), на аз ҷониби шумо (вебҳуки имзошудаи ирсолкунанда-таъминкунанда).

Ҷараёнҳо

• GET /v1/email-marketing/flows — Ҷараёнҳои почтаи электронӣ (хайрамақдам, паёмҳои пайдарпай, санаи солона), як саҳифаи маҷмӯи калидҳо (keyset). Амалиёти listEmailMarketingFlows. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари AI: ҳа, тавассути MCP.
• POST /v1/email-marketing/flows — Сохтани ҷараён (он ҳамчун сиёҳнавис оғоз меёбад). Амалиёти createEmailMarketingFlow. Иҷозатҳои санҷидашуда: email_marketing.manage, email_marketing.view. Аз ёвари AI: ҳа, тавассути MCP.
• DELETE /v1/email-marketing/flows/{flow_id} — Нест кардани ҷараён ва сабтиномҳои он (иҷроҳои ирсолшудаи он ҳамчун маъракаҳо боқӣ мемонанд). Амалиёти deleteEmailMarketingFlow. Иҷозатҳои санҷидашуда: email_marketing.manage, email_marketing.view. Аз ёвари AI: ҳа, тавассути MCP.
• GET /v1/email-marketing/flows/{flow_id} — Як ҷараён бо марҳилаҳо ва ҳисоботи он (сабтиномшуда, дар ҳоли иҷро, иҷроҳо ва қабулкунандагон барои ҳар як марҳила). Амалиёти getEmailMarketingFlow. Иҷозатҳои санҷидашуда: email_marketing.view. Аз ёвари AI: ҳа, тавассути 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.