กำหนดหมายเลขให้กับแคมเปญการส่งข้อความ

กำหนดหมายเลขส่งให้กับแคมเปญ

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

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

คำขอ

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

พารามิเตอร์การกำหนดแคมเปญ
พารามิเตอร์	จำเป็น	ความหมาย
action	ใช่	ใช้ add เพื่อกำหนด หรือ delete เพื่อยกเลิกการเชื่อมโยงแคมเปญปัจจุบันของหมายเลข ตัวพิมพ์ใหญ่-เล็กและช่องว่างโดยรอบจะถูกทำให้เป็นมาตรฐาน
campaign	สำหรับ add	campaignId ของแคมเปญที่มีสถานะ ACTIVE ซึ่งบัญชีที่ผ่านการยืนยันตัวตนเป็นเจ้าของ แบรนด์ของแคมเปญต้องเป็นของบัญชีนี้ด้วย แคมเปญที่ถูกทำเครื่องหมายอย่างชัดเจนว่าเป็น sandbox ไม่สามารถกำหนดให้กับหมายเลขส่งจริงได้ ละพารามิเตอร์นี้สำหรับ delete การยกเลิกจะใช้การเชื่อมโยงที่มีอยู่ของหมายเลข
number	ใช่	หมายเลขส่งที่คุณเป็นเจ้าของ ใช้งานอยู่ ไม่ถูกยกเลิก และรองรับ SMS สำหรับหมายเลขในอเมริกาเหนือ ให้ใช้รหัสประเทศ 1 ตามด้วยตัวเลขสิบหลักของหมายเลขนั้น โดยไม่มีเครื่องหมายบวก ตัวจัดการจะลบอักขระที่ไม่ใช่ตัวเลขออก และยังค้นหารูปแบบเทียบเท่าที่นำหน้าด้วยเครื่องหมายบวกและรูปแบบสิบหลักด้วย การทำให้เป็นมาตรฐานนี้ไม่ใช่การตรวจสอบความถูกต้องของหมายเลขโทรศัพท์โดยทั่วไป

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

ยกเลิกการเชื่อมโยงปัจจุบัน

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

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

การตอบกลับและการตรวจสอบยืนยัน

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

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

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

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

ข้อผิดพลาดและผลลัพธ์บางส่วน

401: ไม่มีบัญชีที่ผ่านการยืนยันตัวตนให้ตัวจัดการใช้งาน
400: action หรือ number ขาดหายไปหรือไม่ถูกต้อง หรือคำขอ add ไม่มีตัวระบุแคมเปญ
404: หมายเลขนี้ไม่ใช่หมายเลข SMS ที่คุณเป็นเจ้าของ ใช้งานอยู่ และไม่ถูกยกเลิก
409: แคมเปญไม่พร้อมใช้งานสำหรับบัญชีนี้ ไม่อยู่ในสถานะ ACTIVE ถูกทำเครื่องหมายอย่างชัดเจนว่าเป็น sandbox หรือแบรนด์ของแคมเปญไม่พร้อมใช้งานสำหรับบัญชีนี้
503: การผสานรวมการส่งข้อความไม่พร้อมใช้งาน โปรดติดต่อฝ่ายสนับสนุนแทนการเปลี่ยนข้อมูลประจำตัวของบัญชีหรือการกำหนดค่าคอนฟิกขึ้นมาเอง
502: คำขอส่งข้อความล้มเหลว หมดเวลา หรือส่งกลับสถานะ HTTP ที่ไม่ใช่ 2xx อาจมีการส่งกลับ providerStatus การหมดเวลาไม่ได้พิสูจน์ว่าพันธมิตรไม่ได้ทำการเปลี่ยนแปลงใด ๆ
500 พร้อม partial=true: พันธมิตรด้านการส่งข้อความส่งกลับสถานะ HTTP ที่สำเร็จ แต่ไม่สามารถยืนยันการเชื่อมโยงภายในระบบได้ โปรดตรวจสอบกระทบยอดหมายเลขในพอร์ทัลหรือติดต่อฝ่ายสนับสนุนก่อนลองใหม่

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

ขอบเขตและผลกระทบ

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

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