เลือกแบรนด์ที่มีอยู่ในบัญชีของคุณ
เริ่มจากรหัสแบรนด์ในระบบทะเบียนที่เชื่อมโยงกับบัญชี MultiTEL ของคุณอยู่แล้ว การค้นหานี้ไม่ได้สร้างแบรนด์หรือเชื่อมโยงแบรนด์ของผู้อื่นเข้ากับบัญชีของคุณ ขั้นตอนการใช้งานของลูกค้าในปัจจุบันตรวจสอบความเป็นเจ้าของก่อนขอข้อมูลคุณสมบัติ หากการค้นหาส่งคืน 404 ให้ตรวจสอบบัญชีและแบรนด์ที่เลือก แทนการใช้รหัสแถวข้อมูลภายในระบบมาแทน
สร้างตัวเลือกรูปแบบการใช้งานจากผลลัพธ์นี้
แค็ตตาล็อกรูปแบบการใช้งานทั่วไปอธิบายตัวเลือกของระบบทะเบียน การค้นหาเฉพาะแบรนด์นี้ให้ตัวเลือกสำหรับแบรนด์ที่เลือก เก็บค่าของแต่ละฟิลด์ usecase ที่ส่งคืนไว้ และนำไปใช้ร่วมกับชื่อที่แสดงและคำอธิบายจากแค็ตตาล็อก อย่าเสนอตัวเลือกทุกรายการในแค็ตตาล็อกทั่วไปเสมือนว่าแบรนด์มีคุณสมบัติครบสำหรับทุกรายการ
พอร์ทัลคาดว่าการตอบกลับนี้จะเป็นรายการในรูปแบบ JSON หากไม่มีการตอบกลับ รูปแบบไม่ถูกต้อง หรือเป็นข้อผิดพลาด ให้เก็บแบบฟอร์มของลูกค้าไว้และแสดงว่าไม่สามารถโหลดข้อมูลคุณสมบัติได้ อย่าถือว่าเป็นการอนุมัติรูปแบบการใช้งานเริ่มต้นโดยไม่แจ้งให้ทราบ ระบบทะเบียนอาจส่งคืนฟิลด์อื่นนอกเหนือจากที่แสดงในตัวอย่างแบบย่อ
โหลดข้อกำหนดสำหรับรูปแบบการใช้งานที่เลือก
หลังจากลูกค้าเลือกค่ารูปแบบการใช้งานที่ส่งคืนมาแล้ว ให้ส่งคำขอไปยัง /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} สำหรับแบรนด์เดียวกัน การตอบกลับนั้นให้ขอบเขตของรูปแบบการใช้งานย่อยและข้อกำหนดเฉพาะของแต่ละเครือข่าย ใช้ข้อมูลนี้เพื่อรวบรวมตัวอย่างข้อความ ความยินยอม และคำรับรองอื่นที่จำเป็น รายการคุณสมบัติเพียงอย่างเดียวไม่เพียงพอที่จะจัดทำคำขอลงทะเบียนแคมเปญให้ครบถ้วน
ตรวจสอบราคาของบัญชีแยกต่างหาก
ฟิลด์ของผู้ให้บริการ เช่น monthlyFee, quarterlyFee หรือ annualFee เมื่อส่งคืนมา จะอธิบายเมทาดาทาค่าธรรมเนียมของผู้ให้บริการ ข้อมูลเหล่านี้ใช้แทนราคาของบัญชีลูกค้าหรือเงื่อนไขการลงทะเบียนไม่ได้ พอร์ทัลปัจจุบันอ่านราคาขายปลีกของแคมเปญแยกต่างหาก แล้วนำมารวมกับข้อมูลคุณสมบัติในหน้าตรวจสอบ อย่าอนุมานยอดเรียกเก็บจากลูกค้าจากราคาที่กำหนดตายตัวไว้ในโค้ดของฟังก์ชันช่วยจัดการชนิดแจงนับรุ่นเก่า
รีเฟรชเมื่อเปลี่ยนแบรนด์หรือรูปแบบการใช้งาน
เมื่อเปลี่ยนแบรนด์ ให้ล้างตัวเลือกของแบรนด์เดิมและโหลดข้อมูลคุณสมบัติสำหรับแบรนด์ที่เลือกใหม่ รีเฟรชข้อกำหนดของรูปแบบการใช้งานที่เลือกก่อนส่งคำขอลงทะเบียน คำขอ GET เหล่านี้ไม่ได้ส่งคำขอลงทะเบียน เปิดใช้งานแคมเปญ หรือกำหนดหมายเลขโทรศัพท์
คำขอ
ใช้บัญชี API ที่เปิดใช้งานแล้วผ่าน HTTPS จากที่อยู่ IP ต้นทางที่ได้รับอนุญาต เส้นทางปัจจุบันรองรับนโยบายการยืนยันตัวตนของบัญชี รวมถึงการยืนยันตัวตนแบบ Basic และบัญชี API แบบโทเค็นผู้ถือที่เปิดใช้งานแล้ว อย่าใช้ข้อมูลรับรองของผู้ให้บริการ
ส่ง GET โดยใส่รหัสแบรนด์ในเส้นทาง URL ไม่ต้องมีเนื้อหาคำขอ
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| ชื่อ | ชนิด | จำเป็น | คำอธิบาย |
|---|---|---|---|
brand_id | สตริง | ใช่ | รหัสแบรนด์ในระบบทะเบียนที่เชื่อมโยงกับบัญชี MultiTEL ของคุณซึ่งยืนยันตัวตนแล้ว ใช้รหัสแบรนด์ ไม่ใช่รหัสแถวในฐานข้อมูลภายในระบบ รหัสแคมเปญ หรือเลขประจำตัวผู้เสียภาษีของธุรกิจ เข้ารหัสค่านี้เป็นส่วนเดียวในเส้นทาง URL |
การตอบกลับ
เส้นทาง TCR ปัจจุบันส่งคืนเนื้อหา JSON ของระบบทะเบียนโดยตรงและคงสถานะ HTTP ไว้ โดยไม่เพิ่มโครงสร้างห่อหุ้ม status/response แบบเดิมของ v3 ตัวอย่างสมมติแบบย่อนี้ไม่ใช่ผลคุณสมบัติจากระบบจริง ตรวจสอบสถานะ HTTP และโครงสร้าง JSON ที่คาดไว้ก่อนใช้งาน พอร์ทัลปัจจุบันคาดว่าจะได้รับรายการระเบียนคุณสมบัติ โดยแต่ละระเบียนระบุ usecase พอร์ทัลนำระเบียนเหล่านี้มาใช้ร่วมกับแค็ตตาล็อก usecase เพื่อแสดงชื่อ และอ่านราคาขายปลีกแยกต่างหาก อาจมีฟิลด์เพิ่มเติมจากผู้ให้บริการ
โครงสร้างการตอบกลับเพื่อประกอบความเข้าใจ ไม่ใช่ข้อมูลบัญชีจากระบบจริงหรือใบเสนอราคาปัจจุบัน
[
{
"usecase": "2FA"
}
]ข้อผิดพลาด
- 401: การยืนยันตัวตนของบัญชีไม่สำเร็จ ตรวจสอบข้อมูลรับรอง API สถานะการเปิดใช้งาน และข้อจำกัด IP ต้นทางที่มีผลบังคับใช้
- 404: แบรนด์ไม่ได้เชื่อมโยงกับบัญชีที่ยืนยันตัวตนแล้ว หรือผู้ให้บริการไม่พบแบรนด์หรือตัวเลือกที่ร้องขอ ระบบภายในจะส่งคืนการปฏิเสธเนื่องจากไม่มีความเป็นเจ้าของก่อนส่งคำขอไปยังผู้ให้บริการ
- ข้อผิดพลาดอื่นจากระบบทะเบียน: คงสถานะ HTTP และเนื้อหาจากระบบต้นทางไว้ รูปแบบการใช้งานที่ไม่ถูกต้องหรือไม่พร้อมใช้งานไม่ถือเป็นผลสำเร็จที่มีชุดข้อกำหนดว่างเปล่า
- 429: ถึงขีดจำกัดคำขอของบัญชีหรือขีดจำกัดที่ใช้ร่วมกันของผู้ให้บริการแล้ว ปฏิบัติตาม Retry-After
- 502/503: การรับส่งข้อมูลล้มเหลว หรือผู้ให้บริการหรือตัวจำกัดอัตราคำขอไม่พร้อมใช้งาน เก็บแบบฟอร์มไว้และลองใหม่โดยเพิ่มช่วงเวลารอระหว่างการลองแต่ละครั้ง
ความพร้อมใช้งานและผลกระทบที่เกิดขึ้น
- คำขอ GET ที่ตรวจทานแล้วจะตรวจสอบความเป็นเจ้าของแบรนด์ที่มีอยู่ ติดต่อระบบทะเบียน และเขียนระเบียนตรวจสอบคำขอ โดยไม่ได้สร้างแบรนด์หรือแคมเปญ และไม่เรียกเก็บค่าธรรมเนียมการลงทะเบียน
- เมทาดาทาค่าธรรมเนียมของผู้ให้บริการไม่ใช่ใบเสนอราคาขายปลีกสำหรับลูกค้า MultiTEL พอร์ทัลตรวจสอบราคาของบัญชีแยกต่างหากก่อนส่งคำขอลงทะเบียนในขั้นตอนถัดไป
- คุณสมบัติและข้อกำหนดอาจเปลี่ยนแปลงได้ ให้รีเฟรชข้อมูลเหล่านี้สำหรับแบรนด์และรูปแบบการใช้งานที่เลือกก่อนส่งคำขอลงทะเบียน การค้นหาสำเร็จไม่ได้หมายถึงการอนุมัติแคมเปญ การกำหนดหมายเลขโทรศัพท์ หรือการอนุญาตให้เริ่มส่งข้อความ