Басқару тақтасындағы Zinn® Campaigns жүйесінде орындай алатын барлық әрекеттерді API арқылы да орындауға болады, және олардың көпшілігін MCP арқылы тіркелгіңізге қосылған ЖИ көмекшісінен де жүзеге асыруға болады. Бұл нұсқаулық жүйеге кіруді, рұқсаттарды, екі тәсіл бойынша толық мысалды, шектеулерді, қателерді және Campaigns жүйесінің 89 операциясының әрқайсысын қамтиды. Төмендегі операциялар тізімі біздің API спецификациямыздан жасалған, сондықтан ол әрқашан API жұмысына сәйкес келеді. Әрбір операцияның әрбір өрісі zinndigital.com/developers/api/zinn-campaigns сілтемесіндегі API анықтамалығында берілген.
Жүйеге кіру
- API кілттері. Басқару тақтасындағы Параметрлер → API кілттері бөлімінде кілт жасап, оны
Authorization: Bearer zdk_live_… түрінде жіберіңіз (сынақ режимінде zdk_test_… кілті жұмыс істейді). Кілтке тек қажетті Campaigns рұқсаттарын беріңіз, артық рұқсат бермеңіз.
- ЖИ көмекшілері (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 хабарламаларын жіберу, ЖИ кредиттерімен жазу, US мәтіндік хабарламаларына тіркелу — көмекшіге тыйым салынған, сондықтан қате түсінілген нұсқау тұтынушыларыңызға ешқашан жетпейді. Көмекші нобайды дайындайды; Сіз басқару панелінде Жіберу түймесін басасыз немесе API-ді өзіңіз шақырасыз. SMTP құпиясөзі сияқты құпия деректер де көмекші арқылы ешқашан берілмейді: оларды басқару панеліне енгізіңіз.
Шектеулер
- Әр адам немесе API кілті үшін минутына 1 200 сұрау, және әр ұйым үшін минутына 6 000 сұрау. Екеуінің ішіндегі қатаңырақ шектеу қолданылады.
- Әр MCP байланысы үшін минутына 600 сұрау.
- Шектеуден асқан жағдайда, жауап
Retry-After тақырыптамасы бар 429 болады: сонша секунд күтіңіз.
- Тізім мүшелерін қосу бір сұрауға ең көбі 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 тақырыпшасындағы секунд санын күтіңіз.
Вебхуктер
Жеткізу нәтижелері Zinn® Campaigns жүйесіне электрондық поштаңызды жіберетін провайдерден түседі:
- Жеке провайдеріңізбен (мысалы, Resend), оның вебхукке қол қою құпиясын басқару тақтасындағы жіберу қосылымында (Campaigns → Жіберу) сақтаңыз. Сіз
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. ЖИ көмекшісінен: тек 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 — Бір контактіге бір SMS жіберу, Zinn® несие балансынан төленеді. sendEmailMarketingMessage операциясы. Тексерілген рұқсаттар: email_marketing.manage, email_marketing.view. ЖИ ассистентінен: тек API және басқару тақтасы: бұл ақшаны немесе лимитті жұмсайды, сондықтан оны адам басады (контактіге бір реттік хабарлама лимитті жұмсайды).
GET /v1/email-marketing/messages — Ұйым жіберген SMS және WhatsApp хабарламалары, алдымен жаңалары, бір 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 — Электрондық пошта мекенжайы бойынша контактілерді тізімге қосу (сұранысқа ең көбі 1 000). addEmailMarketingListMembers операциясы. Тексерілетін рұқсаттар: email_marketing.manage, email_marketing.view. ЖИ көмекшісінен: иә, MCP арқылы.
Импорттар
GET /v1/email-marketing/imports — Бұрынғы контактілерді импорттау тарихы, алдымен жаңалары, бір уақытта бір кілттер жиынтығы беті. 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 — Осы қосылым үшін электрондық пошта провайдеріңіздің 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. ЖИ көмекшісінен: тек 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 және басқару тақтасы: оның құрамында ЖИ моделіне ешқашан жетпеуі тиіс құпия бар (негізгі бөлігі ESP API кілті болып табылады).
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 — Қос растау (double opt-in) беті (жүйеге кірусіз). emailMarketingFormConfirmPage операциясы. Жасанды интеллект көмекшісінен: алушыларыңыз электрондық поштадан ашатын бет (қос растау беті).
POST /v1/public/email-marketing/fc — Тіркелуді растау (адамды келісім жазбасымен бірге тізімге қосады). emailMarketingFormConfirm операциясы. Жасанды интеллект көмекшісінен: сіз емес, басқа жүйе (провайдер немесе келуші) шақырады (келуші қос растауды орындайды).
GET /v1/public/email-marketing/o/{token} — Ашылуды бақылау кескіні (1x1 GIF). Әр алушыға бір ашылуды есептейді. 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 провайдерімізден кіріс SMS жауаптары (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 арқылы.