อ่านข้อกำหนดแคมเปญของแบรนด์

เก็บแบรนด์และกรณีการใช้งานไว้ด้วยกัน

ใช้รหัสแบรนด์ในบัญชีของคุณและค่ากรณีการใช้งานที่ได้รับจากรายการคุณสมบัติของแบรนด์เดียวกันนั้น ขั้นตอนการทำงานของลูกค้าจะตรวจสอบความเป็นเจ้าของก่อนส่งคำขอไปยังผู้ให้บริการ ยืนยันว่าฟิลด์ usecase ของออบเจ็กต์ที่ส่งกลับมาตรงกับค่าที่เลือก การค้นหาสำหรับแบรนด์หรือกรณีการใช้งานหนึ่งไม่ได้กำหนดข้อกำหนดสำหรับอีกรายการหนึ่ง

อ่านข้อกำหนดปัจจุบัน

นำข้อกำหนดของผู้ให้บริการเครือข่ายที่เลือกทั้งหมดมาใช้ร่วมกัน

ข้อกำหนดของผู้ให้บริการเครือข่ายแต่ละรายอาจแตกต่างกัน เมื่อไม่ได้ระบุรายการผู้ให้บริการเครือข่ายอย่างชัดเจน พอร์ทัลจะพิจารณาข้อมูลเมตาของผู้ให้บริการเครือข่ายทั้งหมดในการตอบกลับ ส่วนรายการที่ไม่ว่างจะจำกัดการตรวจสอบให้อยู่เฉพาะรหัสที่เลือกเหล่านั้น อย่าใช้เพียงจำนวนตัวอย่างหรือคำประกาศของผู้ให้บริการเครือข่ายรายแรกเท่านั้น ให้เลือกผู้ให้บริการเครือข่ายจากการตอบกลับ ตรวจสอบการรองรับและคุณสมบัติ ปฏิบัติตามค่าขั้นต่ำของตัวอย่างที่สูงที่สุดที่บังคับใช้ และปฏิบัติตามคำประกาศการสมัครรับ การยกเลิกรับ และความช่วยเหลือที่จำเป็นทั่วทั้งการเลือกนั้น พอร์ทัลจะปฏิเสธรหัสผู้ให้บริการเครือข่ายที่เลือกซึ่งไม่มีอยู่ในการตอบกลับปัจจุบัน และปฏิเสธการเลือกที่ไม่มีผู้ให้บริการเครือข่ายที่มีคุณสมบัติ

ข้อกำหนดอธิบายสิ่งที่ต้องจัดส่งให้ แต่ไม่ได้พิสูจน์ว่ากระบวนการขอความยินยอมหรือเนื้อหาแคมเปญของลูกค้าเป็นไปตามข้อกำหนดเหล่านั้น รวบรวมตัวอย่างและคำประกาศที่เป็นความจริงและเป็นตัวแทนของการใช้งานจริง อย่าเปิดคำประกาศโดยอัตโนมัติเพียงเพื่อให้แบบฟอร์มผ่าน

เตรียมตัวอย่างข้อความและข้อความตอบกลับสมาชิกผู้รับข้อความ

แบบฟอร์มแคมเปญปัจจุบันใช้ sample1 ถึง sample5 สำหรับตัวอย่างข้อความ หากไม่สามารถทำตามข้อกำหนดได้ภายในแบบฟอร์มที่มีอยู่ ให้หยุดและแก้ไขการเลือกร่วมกับฝ่ายสนับสนุน สำหรับคำประกาศของสมาชิกผู้รับข้อความที่เปิดใช้งาน ให้ระบุคีย์เวิร์ดและข้อความตอบกลับที่เกี่ยวข้อง ได้แก่ optinKeywords/optinMessage, optoutKeywords/optoutMessage และ helpKeywords/helpMessage รักษาตัวอย่างให้สอดคล้องกับกรณีการใช้งานที่เลือกและการส่งข้อความจริงถึงลูกค้า

ตรวจทานก่อนส่งคำขอลงทะเบียนใด ๆ

รีเฟรชข้อกำหนดเมื่อแบรนด์ กรณีการใช้งาน หรือการเลือกผู้ให้บริการเครือข่ายเปลี่ยนแปลง พอร์ทัลจะตรวจสอบกรณีการใช้งานที่เลือก จำนวนกรณีการใช้งานย่อย คุณสมบัติของผู้ให้บริการเครือข่าย ตัวอย่าง และคำประกาศอีกครั้งก่อนการสร้าง ตรวจทานราคาของบัญชีและข้อกำหนดการลงทะเบียนแยกต่างหาก GET นี้ไม่ได้ลงทะเบียนหรืออนุมัติแคมเปญ ไม่ได้แบ่งปันแคมเปญกับผู้ให้บริการเครือข่ายรับส่งข้อความ และไม่ได้กำหนดหมายเลขโทรศัพท์ การสร้างและการจัดเตรียมเป็นการดำเนินการแยกต่างหาก

จัดการกับการค้นหาข้อกำหนดที่ล้มเหลว

หากคำขอล้มเหลว ส่งกลับ JSON ที่ไม่คาดคิด หรือไม่ตรงกับกรณีการใช้งานที่เลือก ให้คงแบบฟอร์มไว้ในสถานะไม่สมบูรณ์และให้ลูกค้าลองใหม่หลังจากแก้ไขข้อผิดพลาดแล้ว อย่าแทนที่ข้อกำหนดที่ไม่พร้อมใช้งานด้วยออบเจ็กต์ว่าง และอย่าสันนิษฐานว่าข้อมูลที่หายไปหมายถึงไม่มีข้อกำหนด ให้เคารพ Retry-After และใช้การหน่วงเวลาแบบถอยหลัง (backoff) สำหรับการจำกัดอัตราและความล้มเหลวด้านความพร้อมใช้งาน

คำขอ

ใช้บัญชี API ที่เปิดใช้งานผ่าน HTTPS จากที่อยู่ IP ต้นทางที่ได้รับอนุญาต เส้นทางปัจจุบันรองรับนโยบายการยืนยันตัวตนของบัญชี รวมถึงการยืนยันตัวตนแบบ Basic และบัญชี API แบบ bearer ที่เปิดใช้งาน อย่าใช้ข้อมูลประจำตัวของผู้ให้บริการ

GET โดยระบุรหัสแบรนด์และค่ากรณีการใช้งานที่เลือกในเส้นทาง URL ไม่จำเป็นต้องมีเนื้อหาคำขอ

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

การตอบกลับ

เส้นทาง TCR ปัจจุบันส่งกลับเนื้อหา JSON ของทะเบียนโดยตรงและคงสถานะ HTTP ของทะเบียนไว้ โดยไม่เพิ่มซอง status/response แบบเดิมของ v3 ตัวอย่างสมมติแบบย่อนี้ไม่ใช่ผลการพิจารณาคุณสมบัติจริง ตรวจสอบสถานะ HTTP และรูปแบบ JSON ที่คาดไว้ก่อนนำไปใช้ พอร์ทัลคาดหวังออบเจ็กต์ที่มี usecase ตรงกับกรณีการใช้งานที่เลือก ข้อกำหนดของผู้ให้บริการเครือข่ายอยู่ภายใต้ mnoMetadata โดยจัดเรียงตามรหัสผู้ให้บริการเครือข่าย รหัสผู้ให้บริการเครือข่ายและข้อกำหนดในตัวอย่างเป็นข้อมูลสมมติ อาจมีการส่งกลับฟิลด์อื่น ๆ ของผู้ให้บริการด้วย

รูปแบบการตอบกลับเพื่อประกอบคำอธิบาย ไม่ใช่ข้อมูลบัญชีจริงหรือใบเสนอราคาปัจจุบัน

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

ข้อผิดพลาด

• 401: การยืนยันตัวตนของบัญชีล้มเหลว ตรวจสอบข้อมูลประจำตัว API สถานะการเปิดใช้งาน และข้อจำกัด IP ต้นทางที่บังคับใช้
• 404: แบรนด์ไม่ได้เชื่อมโยงกับบัญชีที่ผ่านการยืนยันตัวตน หรือผู้ให้บริการไม่พบแบรนด์หรือการเลือกที่ร้องขอ การปฏิเสธความเป็นเจ้าของในระบบท้องถิ่นจะถูกส่งกลับก่อนส่งคำขอไปยังผู้ให้บริการ
• ข้อผิดพลาดอื่น ๆ ของทะเบียน: สถานะ HTTP และเนื้อหาจากต้นทางจะถูกคงไว้ กรณีการใช้งานที่ไม่ถูกต้องหรือไม่พร้อมใช้งานไม่ใช่ชุดข้อกำหนดว่างที่สำเร็จ
• 429: ถึงขีดจำกัดคำขอของบัญชีหรือของผู้ให้บริการที่ใช้ร่วมกัน ให้เคารพ Retry-After
• 502/503: ความล้มเหลวด้านความพร้อมใช้งานของการรับส่ง ผู้ให้บริการ หรือตัวจำกัดอัตรา คงแบบฟอร์มไว้และลองใหม่ด้วยการหน่วงเวลาแบบถอยหลัง (backoff)

ความพร้อมใช้งานและผลข้างเคียง

• GET ที่ตรวจทานแล้วจะตรวจสอบความเป็นเจ้าของแบรนด์ที่มีอยู่ ติดต่อทะเบียน และบันทึกข้อมูลการตรวจสอบคำขอ โดยไม่สร้างแบรนด์หรือแคมเปญ และไม่เรียกเก็บค่าธรรมเนียมการลงทะเบียน
• ข้อมูลเมตาค่าธรรมเนียมของผู้ให้บริการไม่ใช่ใบเสนอราคาขายปลีกสำหรับลูกค้า MultiTEL พอร์ทัลจะตรวจทานราคาของบัญชีแยกต่างหากก่อนคำขอลงทะเบียนในภายหลัง
• คุณสมบัติและข้อกำหนดอาจเปลี่ยนแปลงได้ รีเฟรชข้อมูลเหล่านี้สำหรับแบรนด์และกรณีการใช้งานที่เลือกก่อนส่ง การค้นหาที่สำเร็จไม่ใช่การอนุมัติแคมเปญ การกำหนดหมายเลข หรือการอนุญาตให้เริ่มส่งข้อความ