ปิดใช้งานแคมเปญส่งข้อความที่มีอยู่
ใช้เส้นทางนี้เมื่อต้องการเลิกใช้งานแคมเปญที่บัญชีเป็นเจ้าของ เก็บรหัสแคมเปญไว้สำหรับการกระทบยอดและประวัติ หากต้องการแก้ไขเนื้อหาหรือปรับปรุงข้อความขอความยินยอม ให้ใช้ อัปเดตแคมเปญส่งข้อความ แทน
ยืนยันตัวตนด้วยบัญชี API ที่เปิดใช้งานแล้วผ่าน HTTPS จากที่อยู่ IP ต้นทางที่ได้รับอนุญาต ดึงข้อมูลแคมเปญก่อน แล้วตรวจสอบแบรนด์และหมายเลขที่ใช้ส่งข้อความที่เกี่ยวข้อง การปิดใช้งานจะเปลี่ยนแปลงการลงทะเบียน โดยไม่ได้สร้างแคมเปญทดแทนหรือย้ายหมายเลขไปยังแคมเปญอื่น
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"นำการผูกหมายเลขที่ได้รับผลกระทบออกก่อน
การเรียก DELETE ของแคมเปญผ่านอินเทอร์เฟซสาธารณะไม่ได้ยกเลิกการเชื่อมโยงหมายเลขโทรศัพท์กับผู้ให้บริการส่งข้อความหรือล้างการผูกหมายเลขในระบบภายใน ให้ใช้ ขั้นตอนการนำการผูกหมายเลขกับแคมเปญออก กับหมายเลขที่ได้รับผลกระทบแต่ละหมายเลขซึ่งบัญชีเป็นเจ้าของ จากนั้นตรวจสอบการผูกหมายเลขนั้น การนำการผูกหมายเลขออกไม่ได้เป็นการคืนหมายเลขโทรศัพท์
ขั้นตอนลบแบรนด์บนพอร์ทัลมีขอบเขตกว้างกว่า โดยจะจัดการล้างข้อมูลแคมเปญและหมายเลขของแบรนด์ก่อนลบแบรนด์นั้น อย่าใช้การดำเนินการนี้หากต้องการเก็บแบรนด์และแคมเปญอื่นของแบรนด์ไว้ เครื่องมือแก้ไขแคมเปญทั่วไปในปัจจุบันไม่มีปุ่มลบแคมเปญแยกต่างหากที่เทียบเท่ากับเส้นทาง API โดยตรงนี้
ส่งคำขอปิดใช้งานตามที่ตั้งใจ
หลังจากตรวจทานรหัสแคมเปญและการตั้งค่าการส่งข้อความที่ได้รับผลกระทบแล้ว ให้ส่ง DELETE โดยไม่มีเนื้อหาคำขอแบบ JSON:
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request DELETE \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"การตอบกลับที่สำเร็จตามเอกสารคือ HTTP 204 โดยไม่มีเนื้อหา ให้ตรวจสอบสถานะ HTTP แทนการคาดหวังโครงสร้างห่อหุ้ม status/response แบบ JSON เมื่อยอมรับคำขอลบ บริการปัจจุบันจะทำเครื่องหมายทรัพยากรแคมเปญในระบบภายในว่าถูกลบและหมดอายุแล้ว และทำเครื่องหมายระเบียนแคมเปญแบบเดิมว่าหมดอายุแล้ว การลบนี้ไม่ได้ส่งผลต่อเนื่องไปลบแบรนด์ด้วย
ใช้คีย์ป้องกันการดำเนินการซ้ำเพียงคีย์เดียวสำหรับคำขอที่ตั้งใจส่งนี้ และเก็บเมธอด เส้นทาง พารามิเตอร์การสืบค้น และไบต์ของเนื้อหาคำขอให้ตรงเดิมทุกประการสำหรับการส่งซ้ำ คำขอซ้ำที่กำลังประมวลผลอาจส่งกลับ 409 พร้อม Retry-After ส่วนคำขอที่เสร็จแล้วสามารถส่งผลลัพธ์ที่บันทึกไว้กลับมาอีกครั้งได้ ข้อผิดพลาดที่แคชไว้หรือการเชื่อมต่อที่ขาดหายไม่ได้ยืนยันว่าระบบทะเบียนดำเนินการไปแล้วหรือไม่ ให้เก็บรหัสแคมเปญและ requestId ไว้หากมี
ตรวจสอบทั้งการลงทะเบียนและการผูกหมายเลข
หลังส่งคำขอ ให้ตรวจสอบสถานะปัจจุบันของแคมเปญและหมายเลขที่ได้รับผลกระทบในพอร์ทัล API อาจเก็บข้อมูลเมตาเกี่ยวกับความเป็นเจ้าของไว้ในระบบภายในหลังเลิกใช้งาน จึงยังตรวจสอบรหัสที่บัญชีเป็นเจ้าของได้ อย่าอนุมานว่ารหัสเดิมจะต้องส่งกลับ 404 จากระบบภายในเสมอ ระบบทะเบียนเป็นผู้กำหนดสถานะที่ส่งกลับหรือความพร้อมให้เรียกดูของระเบียนที่เลิกใช้งานแล้ว
หากหมายเลขยังคงผูกอยู่ ให้ตรวจสอบและกระทบยอดการผูกที่มีอยู่นั้น อย่าสร้างแคมเปญอื่นเพียงเพื่อลองปิดใช้งานอีกครั้ง หรือถือว่า HTTP 204 ยืนยันว่าผู้ให้บริการได้ล้างข้อมูลแล้ว หากการซิงโครไนซ์ภายในล้มเหลวหลังจากระบบทะเบียนยอมรับคำขอ API อาจส่งกลับ 500 แม้ว่าการปิดใช้งานในระบบภายนอกจะเกิดขึ้นแล้วก็ตาม
| ผลลัพธ์ | ขั้นตอนถัดไป |
|---|---|
| 204 | การตอบกลับจะไม่มีเนื้อหา ให้ตรวจสอบสถานะแคมเปญและการผูกหมายเลขซึ่งจัดการแยกกันอย่างอิสระ |
| 400 | อ่านข้อความข้อผิดพลาดเกี่ยวกับการตรวจสอบข้อมูลหรือสถานะของระบบทะเบียนที่ส่งมา ตรวจสอบรหัสแคมเปญให้ตรงทุกตัวและตรวจสอบสถานะที่มีอยู่ |
| 401, 403, 404 | ตรวจสอบข้อมูลรับรอง API ที่อยู่ IP ต้นทางที่ได้รับอนุญาต และความเป็นเจ้าของของบัญชี อย่านำรหัสของลูกค้ารายอื่นมาใช้แทน |
| 409, 429 | แยกให้ออกระหว่างคำขอที่ใช้กลไกป้องกันการดำเนินการซ้ำซึ่งกำลังประมวลผลหรือมีข้อขัดแย้ง กับการจำกัดอัตราคำขอ และปฏิบัติตาม Retry-After หากมีการส่งมา |
| 500, 502 หรือหมดเวลารอ | เก็บรายละเอียดคำขอ ดึงข้อมูลแคมเปญที่มีอยู่ และตรวจสอบกระทบยอดก่อนส่งคำขออีกครั้ง |
การเลิกใช้งานแยกจากการชำระบัญชี
บริการ DELETE ปัจจุบันไม่ได้ส่งคำสั่งหักเงินค่าลงทะเบียนแคมเปญทันที ทั้งนี้ไม่ได้รับประกันการคืนเงิน ไม่ได้ลบล้างข้อผูกพันที่มีอยู่ และไม่ได้คืนหมายเลขที่เช่าไว้ ให้ตรวจสอบเงื่อนไขแคมเปญของบัญชีและใบแจ้งหนี้ค้างชำระในพอร์ทัล การเช่าหมายเลขและการใช้งานข้อความแยกจากการลงทะเบียนแคมเปญ
หากต้องการเลิกใช้งานทะเบียนธุรกิจทั้งหมดหลังจากตรวจสอบกระทบยอดแคมเปญและการผูกหมายเลขแล้ว ให้ดำเนินการต่อด้วย การเลิกใช้งานแบรนด์.