ທຸກສິ່ງທີ່ທ່ານສາມາດເຮັດໄດ້ໃນ Zinn® Campaigns ຢູ່ເທິງແດຊບອດ ທ່ານຍັງສາມາດເຮັດໄດ້ຜ່ານ API, ແລະ ສ່ວນໃຫຍ່ແມ່ນມາຈາກຜູ້ຊ່ວຍ AI ທີ່ເຊື່ອມຕໍ່ກັບບັນຊີຂອງທ່ານຜ່ານ MCP. ຄູ່ມືນີ້ກວມເອົາການເຂົ້າສູ່ລະບົບ, ການອະນຸຍາດ, ຕົວຢ່າງການເຮັດວຽກທັງສອງຮູບແບບ, ຂີດຈຳກັດ, ຂໍ້ຜິດພາດ ແລະ ແຕ່ລະການດຳເນີນການທັງໝົດ 89 ລາຍການຂອງ Campaigns. ລາຍການການດຳເນີນການດ້ານລຸ່ມນີ້ຖືກສ້າງຂຶ້ນຈາກຂໍ້ກຳນົດສະເພາະ API ຂອງພວກເຮົາ, ດັ່ງນັ້ນມັນຈຶ່ງກົງກັບສິ່ງທີ່ API ເຮັດສະເໝີ. ທຸກໆຊ່ອງຂໍ້ມູນຂອງແຕ່ລະການດຳເນີນການແມ່ນມີຢູ່ໃນເອກະສານອ້າງອີງ API ທີ່ zinndigital.com/developers/api/zinn-campaigns.
ການເຂົ້າສູ່ລະບົບ
- ຄີ API. ສ້າງຄີໃນແຜງໜ້າປັດພາຍໃຕ້ ການຕັ້ງຄ່າ → ຄີ API ແລະ ສົ່ງມັນເປັນ
Authorization: Bearer zdk_live_… (ຄີ zdk_test_… ໃຊ້ໄດ້ໃນໂໝດ sandbox). ໃຫ້ສິດ Campaigns ທີ່ຈຳເປັນແກ່ຄີ ແລະ ບໍ່ໃຫ້ເກີນນັ້ນ.
- ຜູ້ຊ່ວຍ AI (MCP). ເຊື່ອມຕໍ່ Claude, ChatGPT, Cursor ຫຼື MCP client ໃດໜຶ່ງໃສ່
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.
ຕົວຢ່າງ: ສະບັບຮ່າງດຽວກັນຈາກຜູ້ຊ່ວຍ AI
ຖາມຜູ້ຊ່ວຍຂອງທ່ານດ້ວຍຄຳເວົ້າທຳມະດາ, ຕົວຢ່າງ "ຮ່າງອີເມວ 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 ຈະບໍ່ຖືກສົ່ງຜ່ານຜູ້ຊ່ວຍເຊັ່ນກັນ: ໃຫ້ປ້ອນຂໍ້ມູນເຫຼົ່ານັ້ນໃນໜ້າປັດ.
ຂີດຈຳກັດ
- 1,200 ຄຳຂໍຕໍ່ນາທີ ສຳລັບແຕ່ລະບຸກຄົນ ຫຼື ແຕ່ລະ API key, ແລະ 6,000 ຄຳຂໍຕໍ່ນາທີ ສຳລັບແຕ່ລະອົງກອນ. ລະບຽບການໃດທີ່ເຂັ້ມງວດກວ່າຈະຖືກນຳໃຊ້.
- 600 ຄຳຂໍຕໍ່ນາທີ ສຳລັບແຕ່ລະການເຊື່ອມຕໍ່ MCP.
- ຫາກເກີນຂີດຈຳກັດ, ຄຳຕອບຈະເປັນ
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 ຂອງມັນໄວ້ໃນການເຊື່ອມຕໍ່ການສົ່ງໃນແຜງໜ້າປັດ (Campaigns → Sending). ທ່ານຈະໄດ້ຮັບ
webhook_url; ໃຫ້ຊີ້ນຳເຫດການ delivered, bounced ແລະ complained ຂອງຜູ້ໃຫ້ບໍລິການໄປທີ່ນັ້ນ. ການຕີກັບ ຫຼື ການຮ້ອງຮຽນສະແປມຈະລຶບທີ່ຢູ່ນັ້ນອອກຈາກການສົ່ງໃນອະນາຄົດທັນທີ.
- ດ້ວຍການສົ່ງຂອງ Zinn®, ບໍ່ມີຫຍັງທີ່ຕ້ອງຕັ້ງຄ່າ.
ອ່ານຜົນໄດ້ຮັບດ້ວຍການດຳເນີນງານລາຍງານ (getEmailMarketingCampaignReport, getSmsMarketingCampaignReport).
ທຸກການດຳເນີນງານ Campaigns
ພາບລວມ
GET /v1/email-marketing — ພາບລວມ Zinn® Campaigns ສຳລັບໜຶ່ງອົງກອນ. ການດຳເນີນງານ getEmailMarketingOverview. ສິດອະນຸຍາດທີ່ກວດສອບ: email_marketing.view. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ 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. ຈາກຜູ້ຊ່ວຍ 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 ທີ່ອົງກອນໄດ້ສົ່ງ, ໃໝ່ສຸດຂຶ້ນກ່ອນ, ໜຶ່ງໜ້າຄີເຊັດ. ການດຳເນີນການ listEmailMarketingMessages. ສິດອະນຸຍາດທີ່ກວດສອບແລ້ວ: email_marketing.view. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ 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. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ MCP.
POST /v1/email-marketing/forms — ສ້າງຟອມລົງທະບຽນທີ່ເພີ່ມບຸກຄົນທີ່ຢືນຢັນແລ້ວໃສ່ລາຍຊື່ດຽວ. ການດຳເນີນການ createEmailMarketingForm. ສິດອະນຸຍາດທີ່ກວດສອບ: email_marketing.manage, email_marketing.view. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ MCP.
DELETE /v1/email-marketing/forms/{form_id} — ລຶບຟອມລົງທະບຽນ (ບຸກຄົນທີ່ຢືນຢັນແລ້ວຍັງຄົງຢູ່ໃນລາຍຊື່). ການດຳເນີນການ deleteEmailMarketingForm. ສິດອະນຸຍາດທີ່ກວດສອບ: email_marketing.manage, email_marketing.view. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ MCP.
PATCH /v1/email-marketing/forms/{form_id} — ປ່ຽນແປງຟອມລົງທະບຽນ (ຂໍ້ຄວາມ, ລາຍຊື່, ການປ່ຽນເສັ້ນທາງ, ເປີດ ຫຼື ປິດ). ການດຳເນີນການ updateEmailMarketingForm. ສິດອະນຸຍາດທີ່ກວດສອບ: email_marketing.manage, email_marketing.view. ຈາກຜູ້ຊ່ວຍ AI: ແມ່ນ, ຜ່ານ 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 ຢ່າງເດັດຂາດ (ເນື້ອຫາແມ່ນຄີ API ຂອງ ESP).
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. ຈາກຜູ້ຊ່ວຍ 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. ຈາກຜູ້ຊ່ວຍ 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. ຈາກຜູ້ຊ່ວຍ 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. ຈາກຜູ້ຊ່ວຍ AI: ຖືກເອີ້ນໃຊ້ໂດຍລະບົບອື່ນ (ຜູ້ໃຫ້ບໍລິການ ຫຼື ຜູ້ເຂົ້າຊົມ), ບໍ່ແມ່ນໂດຍທ່ານ (ການຍົກເລີກການຕິດຕາມດ້ວຍການຄລິກດຽວຕາມ RFC 8058).
GET /v1/public/email-marketing/warmup-u/{token} — ລິ້ງຍົກເລີກການຕິດຕາມຂອງອີເມວ warm-up ໃນກຸ່ມການຕະຫຼາດ (ບໍ່ຕ້ອງເຂົ້າສູ່ລະບົບ). ການດຳເນີນງານ emailMarketingWarmupUnsubscribePage. ຈາກຜູ້ຊ່ວຍ AI: ໜ້າທີ່ຜູ້ຮັບຂອງທ່ານເປີດຈາກອີເມວ (ໜ້າຍົກເລີກການຕິດຕາມ warm-up).
POST /v1/public/email-marketing/warmup-u/{token} — ການຍົກເລີກການຕິດຕາມດ້ວຍການຄລິກດຽວຕາມ RFC 8058 ຈາກອີເມວ warm-up. ການດຳເນີນງານ emailMarketingWarmupUnsubscribeOneClick. ຈາກຜູ້ຊ່ວຍ AI: ຖືກເອີ້ນໃຊ້ໂດຍລະບົບອື່ນ (ຜູ້ໃຫ້ບໍລິການ ຫຼື ຜູ້ເຂົ້າຊົມ), ບໍ່ແມ່ນໂດຍທ່ານ (ການຍົກເລີກການຕິດຕາມ warm-up ດ້ວຍການຄລິກດຽວ).
POST /v1/webhooks/campaign-events — ຮັບເຫດການການຈັດສົ່ງທີ່ລົງລາຍເຊັນແລ້ວຈາກຜູ້ໃຫ້ບໍລິການອີເມວ. ການດຳເນີນງານ receiveCampaignDeliveryWebhook. ຈາກຜູ້ຊ່ວຍ AI: ຖືກເອີ້ນໃຊ້ໂດຍລະບົບອື່ນ (ຜູ້ໃຫ້ບໍລິການ ຫຼື ຜູ້ເຂົ້າຊົມ), ບໍ່ແມ່ນໂດຍທ່ານ (webhook ການຈັດສົ່ງຂອງ ESP ທີ່ລົງລາຍເຊັນແລ້ວ).
POST /v1/webhooks/campaigns/telnyx — ການຕອບກັບ SMS ຂາເຂົ້າ (STOP / START) ຈາກຜູ້ໃຫ້ບໍລິການ SMS ຂອງພວກເຮົາ. ການດຳເນີນງານ receiveCampaignsTelnyxInbound. ຈາກຜູ້ຊ່ວຍ AI: ຖືກເອີ້ນໃຊ້ໂດຍລະບົບອື່ນ (ຜູ້ໃຫ້ບໍລິການ ຫຼື ຜູ້ເຂົ້າຊົມ), ບໍ່ແມ່ນໂດຍທ່ານ (webhook ຂາເຂົ້າຂອງ Telnyx ທີ່ລົງລາຍເຊັນແລ້ວ).
POST /v1/webhooks/email-marketing/{connection_id} — ເຫດການການຈັດສົ່ງຂອງຜູ້ໃຫ້ບໍລິການອີເມວຂອງລູກຄ້າເອງ ສຳລັບການເຊື່ອມຕໍ່ການສົ່ງໜຶ່ງລາຍການ. ການດຳເນີນການ receiveEmailMarketingProviderWebhook. ຈາກຜູ້ຊ່ວຍ AI: ຖືກເອີ້ນໃຊ້ໂດຍລະບົບອື່ນ (ຜູ້ໃຫ້ບໍລິການ ຫຼື ຜູ້ເຂົ້າຊົມ), ບໍ່ແມ່ນໂດຍທ່ານ (webhook ຜູ້ສົ່ງ-ຜູ້ໃຫ້ບໍລິການທີ່ເຊັນຊື່ແລ້ວ).
Flows
GET /v1/email-marketing/flows — ຂັ້ນຕອນອີເມວ (ການຕ້ອນຮັບ, drip, ວັນທີປະຈຳປີ), ໜຶ່ງໜ້າ 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. ຈາກຜູ້ຊ່ວຍ 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.