Zinn® Campaigns API болон MCP: хөгжүүлэгчийн гарын авлага

Хянах самбар дээрх Zinn® Campaigns дээр хийж болох бүх зүйлийг API-аар дамжуулан хийх боломжтой бөгөөд ихэнх үйлдлийг нь MCP-ээр таны бүртгэлд холбогдсон хиймэл оюуны туслахаас хийж болно. Энэхүү гарын авлагад нэвтрэх, зөвшөөрлүүд, хоёр талын ажилласан жишээ, хязгаарлалтууд, алдаанууд болон Campaigns-ийн 89 үйлдлийн бүрийг хамарсан болно. Доорх үйлдлүүдийн жагсаалтыг манай API-ийн техникийн тодорхойлолтоос үүсгэсэн тул API-ийн хийдэг зүйлтэй үргэлж нийцдэг. Үйлдэл бүрийн бүх талбар нь zinndigital.com/developers/api/zinn-campaigns хаяг дахь API лавлагаанд байгаа.

Нэвтрэх

• API түлхүүрүүд. Хяналтын самбарын Тохиргоо → API түлхүүрүүд хэсэгт түлхүүр үүсгээд, түүнийгээ Authorization: Bearer zdk_live_… хэлбэрээр илгээнэ үү (sandbox горимд zdk_test_… түлхүүр ажиллана). Түлхүүрт зөвхөн шаардлагатай Campaigns эрхүүдийг олгож, үүнээс илүүг бүү олгоно уу.
• Хиймэл оюун ухааны туслахууд (MCP). Claude, ChatGPT, Cursor эсвэл дурын MCP клиентийг аппликэйшнээс нэвтрэх эсвэл холболтын токен (zmcp_live_…) ашиглан 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-ээр илгээнэ үү.

Жишээ: AI туслахаас авсан ижил ноорог

Туслахаасаа энгийн үгээр асууна уу, жишээлбэл "'Our spring sale starts today' гарчигтай Spring sale нэртэй 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 түлхүүр бүрд минутад 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 толгой хэсэгт заасан секундийн хугацаанд хүлээнэ үү.

Webhooks

Хүргэлтийн үр дүнгүүд таны имэйлийг илгээдэг үйлчилгээ үзүүлэгчээс Zinn® Campaigns руу ирдэг:

• Өөрийн үйлчилгээ үзүүлэгчтэй бол (жишээ нь Resend), хянах самбар (Campaigns → Sending) дээрх илгээх холболтод түүний webhook-ийн гарын үсгийн нууцыг хадгална уу. Та webhook_url авах бөгөөд үйлчилгээ үзүүлэгчийн delivered, bounced болон complained үйлдлүүдийг үүн рүү чиглүүлнэ үү. Буцаагдсан эсвэл спам гэсэн гомдол гарсан хаягийг цаашдын илгээлтүүдээс нэн даруй хасна.
• 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. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/email-marketing/campaigns — Ноорог и-мэйл аян үүсгэх. Үйлдэл createEmailMarketingCampaign. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/email-marketing/campaigns/{campaign_id} — Нэг и-мэйл аян. Үйлдэл getEmailMarketingCampaign. Шалгасан зөвшөөрлүүд: email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• PATCH /v1/email-marketing/campaigns/{campaign_id} — Нооргийг засах (эсвэл татгалзсан аяныг засах бөгөөд энэ нь ноорог төлөвт шилжинэ). Үйлдэл updateEmailMarketingCampaign. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/email-marketing/campaigns/{campaign_id}/lint — Аяныг илгээхээс өмнө түүний эх бичвэрийг хүргэлтийн асуудал байгаа эсэхийг шалгах. Үйлдэл lintEmailMarketingCampaign. Шалгасан зөвшөөрлүүд: email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/email-marketing/campaigns/{campaign_id}/report — Аяны тоон үзүүлэлтүүд. Үйлдэл getEmailMarketingCampaignReport. Шалгасан зөвшөөрлүүд: email_marketing.view. AI туслахаас: тийм, 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® кредитийн үлдэгдлээс төлбөрийг нь төлж, нэг харилцагч руу нэг SMS илгээх. Үйлдэл sendEmailMarketingMessage. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. Хиймэл оюуны туслахаас: зөвхөн API болон хянах самбар: энэ нь мөнгө эсвэл лимит зарцуулдаг тул хүн өөрөө дардаг (харилцагч руу нэг удаа илгээх зурвас нь лимит зарцуулдаг).
• GET /v1/email-marketing/messages — Байгууллагын илгээсэн SMS болон 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 — И-мэйл хаягаар жагсаалтад харилцагчид нэмэх (хүсэлт бүрд хамгийн ихдээ 1,000). Үйлдэл 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. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/email-marketing/senders — Кампанит ажил илгээгчийг холбох (Zinn® илгээлт, эсвэл харилцагчийн өөрийн SMTP сервер). createEmailMarketingSender үйлдэл. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: зөвхөн API болон хянах самбар: энэ нь AI загварт хэзээ ч хүрч болохгүй нууцыг агуулна (үндсэн бие нь SMTP нууц үг байна).
• DELETE /v1/email-marketing/senders/{sender_id} — Илгээх холболт болон түүний хадгалсан нууц үгийг устгах. deleteEmailMarketingSender үйлдэл. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/email-marketing/senders/{sender_id}/verify — Юу ч илгээлгүйгээр илгээх холболт ажиллаж байгааг баталгаажуулах. verifyEmailMarketingSender үйлдэл. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• PUT /v1/email-marketing/senders/{sender_id}/webhook — Энэхүү холболтод зориулж таны имэйл үйлчилгээ үзүүлэгчийн вебхүүкийн гарын үсэг зурах нууц түлхүүрийг хадгалах. setEmailMarketingSenderWebhook үйлдэл. Шалгасан зөвшөөрлүүд: email_marketing.manage, email_marketing.view. AI туслахаас: та биш, өөр систем дуудна (үйлчилгээ үзүүлэгч эсвэл зочин) (үйлчилгээ үзүүлэгчийн вебхүүкийн нууцыг хадгална).

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. AI туслахаас: Зөвхөн API болон хянах самбар: энэ нь AI загварт хэзээ ч хүрч болохгүй нууц мэдээллийг агуулдаг (хадгалсан ESP түлхүүрийг устгана).
• GET /v1/campaigns/esp — Байгууллагын өөрийн цахим шуудан үйлчилгээ үзүүлэгчийн бүртгэл. Ажиллагаа getEspConnection. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/campaigns/esp — Цахим шуудан үйлчилгээ үзүүлэгчийн бүртгэлийг холбоно. Ажиллагаа connectEsp. AI туслахаас: Зөвхөн API болон хянах самбар: энэ нь AI загварт хэзээ ч хүрч болохгүй нууц мэдээллийг агуулдаг (их бие нь ESP API түлхүүр байна).
• POST /v1/campaigns/esp/verify — Үйлчилгээ үзүүлэгчийн бүртгэл ажиллаж байгааг баталгаажуулж, баталгаажсан домэйнуудыг нь уншина. Ажиллагаа verifyEspConnection. AI туслахаас: Зөвхөн API болон хянах самбар: энэ нь AI загварт хэзээ ч хүрч болохгүй нууц мэдээллийг агуулдаг (хадгалсан ESP түлхүүрийг дахин шалгана).
• POST /v1/campaigns/preview — Загварыг жишээ утгуудаар Render хийнэ. Ажиллагаа previewCampaignTemplate. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/campaigns/segments — Таны хадгалсан үзэгчдийн сегментүүд. Ажиллагаа listCampaignSegments. Шалгасан зөвшөөрлүүд: campaigns.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/campaigns/segments — Үзэгчдийн шинэ сегмент хадгална. Ажиллагаа createCampaignSegment. Шалгасан зөвшөөрлүүд: campaigns.manage. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/campaigns/segments/fields — Шүүлтүүрийн үгсийн сан, түүний утгуудын жагсаалт ба шидэт шошгууд. Үйлдэл: getCampaignSegmentFields. Шалгасан зөвшөөрлүүд: campaigns.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/campaigns/segments/preview — Энэ нь хичнээн хүнд хүрэх, тэд хэн болох, хэнийг хасах тухай. Үйлдэл: previewCampaignSegment. Шалгасан зөвшөөрлүүд: campaigns.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• DELETE /v1/campaigns/segments/{segmentId} — Сегментийг архивлах. Үйлдэл: archiveCampaignSegment. Шалгасан зөвшөөрлүүд: campaigns.manage. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/campaigns/segments/{segmentId} — Хадгалсан нэг сегмент. Үйлдэл: getCampaignSegment. Шалгасан зөвшөөрлүүд: campaigns.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• PATCH /v1/campaigns/segments/{segmentId} — Сегментийн нэрийг өөрчлөх эсвэл түүний шүүлтүүрийг өөрчлөх. Үйлдэл: updateCampaignSegment. Шалгасан зөвшөөрлүүд: campaigns.manage. AI туслахаас: тийм, MCP-ээр дамжуулан.
• GET /v1/campaigns/suppressions — Маркетинг хүлээн авах ёсгүй хаягууд. Үйлдэл: listCampaignSuppressions. Шалгасан зөвшөөрлүүд: campaigns.view. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/campaigns/suppressions — Хасах жагсаалтад хаяг нэмэх. Үйлдэл: createCampaignSuppression. Шалгасан зөвшөөрлүүд: campaigns.manage. AI туслахаас: тийм, 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. AI туслахаас: тийм, MCP-ээр дамжуулан.
• POST /v1/campaigns/{campaignId}/control — Идэвхтэй илгээлтийг түр зогсоох, үргэлжлүүлэх эсвэл цуцлах. Үйлдэл controlCampaign. AI туслахаас: зөвхөн API ба хянах самбар: энэ нь мөнгө эсвэл лимит зарцуулдаг тул хүн дарж гүйцэтгэнэ (шууд илгээлтийг түр зогсоох/үргэлжлүүлэх).
• POST /v1/campaigns/{campaignId}/send — Найдвартай илгээлтийг эхлүүлэх. Үйлдэл sendCampaign. AI туслахаас: зөвхөн API ба хянах самбар: энэ нь мөнгө эсвэл лимит зарцуулдаг тул хүн дарж гүйцэтгэнэ (бодит хүлээн авагчид руу ESP аяныг илгээх).
• POST /v1/campaigns/{campaignId}/test — Тухайн аяны бодитоор ашиглах сувгаар нэг бодит зурвас илгээх. Үйлдэл testSendCampaign. AI туслахаас: зөвхөн API ба хянах самбар: үүнд AI холболтод олгогддоггүй зөвшөөрөл шаардлагатай (ESP туршилтын илгээлтэд campaigns.send шаардлагатай).

Нийтийн хуудаснууд ба ирж буй вэбхүүкүүд

• GET /v1/public/email-marketing/c/{token} — Товшилтын тоолуур. Хүлээн авагч бүрийн нэг товшилтыг бүртгэж, анхны холбоос руу шилжүүлдэг. Үйлдэл emailMarketingClick. AI туслахаас: таны хүлээн авагчдын имэйлээс нээх хуудас (товшилт хянах шилжүүлэгч).
• GET /v1/public/email-marketing/f/{public_id} — Бүртгэлийн маягтын байршуулсан хуудас (нэвтрэх шаардлагагүй). Үйлдэл emailMarketingFormPage. AI туслахаас: таны хүлээн авагчдын имэйлээс нээх хуудас (нийтийн бүртгэлийн маягтын хуудас).
• 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} — Нээлтийг хянах зураг (1x1 GIF). Нэг хүлээн авагчид нэг нээлтийг тооцно. Үйлдэл emailMarketingOpenPixel. Хиймэл оюун ухааны туслахаас: Таны хүлээн авагчид имэйлээс нээдэг хуудас (нээлтийг хянах пиксел).
• GET /v1/public/email-marketing/u/{token} — Хөлийн бүртгэл цуцлах холбоос (нэвтрэх шаардлагагүй). Үйлдэл emailMarketingUnsubscribePage. Хиймэл оюун ухааны туслахаас: Таны хүлээн авагчид имэйлээс нээдэг хуудас (бүртгэл цуцлах хуудас).
• POST /v1/public/email-marketing/u/{token} — RFC 8058 нэг товшилтоор бүртгэл цуцлах (болон хуудасны "бүгдийг зогсоох" товчлуур). Үйлдэл emailMarketingUnsubscribeOneClick. AI туслахаас: та биш, өөр систем (үйлчилгээ үзүүлэгч эсвэл зочин) дуудсан (RFC 8058 нэг товшилтоор бүртгэл цуцлах).
• GET /v1/public/email-marketing/warmup-u/{token} — Маркетингийн сангийн warmup имэйлийн бүртгэл цуцлах холбоос (нэвтрэх шаардлагагүй). Үйлдэл emailMarketingWarmupUnsubscribePage. AI туслахаас: хүлээн авагчид тань имэйлээс нээх хуудас (warmup бүртгэл цуцлах хуудас).
• POST /v1/public/email-marketing/warmup-u/{token} — Warmup имэйлээс RFC 8058 нэг товшилтоор бүртгэл цуцлах. Үйлдэл emailMarketingWarmupUnsubscribeOneClick. AI туслахаас: та биш, өөр систем (үйлчилгээ үзүүлэгч эсвэл зочин) дуудсан (warmup нэг товшилтоор бүртгэл цуцлах).
• POST /v1/webhooks/campaign-events — Имэйл үйлчилгээ үзүүлэгчээс гарын үсэгтэй хүргэлтийн үйл явдлыг хүлээн авах. Үйлдэл receiveCampaignDeliveryWebhook. AI туслахаас: та биш, өөр систем (үйлчилгээ үзүүлэгч эсвэл зочин) дуудсан (гарын үсэгтэй ESP хүргэлтийн вэбхүүк).
• POST /v1/webhooks/campaigns/telnyx — Манай SMS нийлүүлэгчээс ирэх SMS хариултууд (STOP / START). Үйлдэл receiveCampaignsTelnyxInbound. AI туслахаас: та биш, өөр систем (үйлчилгээ үзүүлэгч эсвэл зочин) дуудсан (гарын үсэгтэй Telnyx ирж буй вэбхүүк).
• POST /v1/webhooks/email-marketing/{connection_id} — Нэг илгээх холболтод зориулсан харилцагчийн өөрийн имэйл үйлчилгээ үзүүлэгчийн хүргэлтийн үйл явдлууд. Ажиллагаа receiveEmailMarketingProviderWebhook. AI туслахаас: та биш, өөр систем (үйлчилгээ үзүүлэгч эсвэл зочин) дуудсан (гарын үсэгтэй илгээгч-үйлчилгээ үзүүлэгчийн вэбхүүк).

Flows

• GET /v1/email-marketing/flows — Имэйлийн урсгалууд (угтах, цуврал, жилийн тодорхой огноо), нэг түлхүүрийн хуудас. Ажиллагаа 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-ээр дамжуулан.