เอกสาร REST API
REST API สำหรับ SMS และ MMS
ส่งข้อความของแอปพลิเคชันที่ได้รับอนุมัติ และจัดการการรับคำขอ เหตุการณ์การนำส่ง การแบ่งเซกเมนต์ และค่าใช้จ่าย
เลือก API และข้อมูลรับรองไปพร้อมกัน
บัญชีนักพัฒนาและระบบอัตโนมัติ ธุรกิจ และผู้ให้บริการสื่อสารที่ได้รับอนุมัติสามารถเชื่อมต่อบริการที่เปิดใช้งานได้ นักพัฒนารายบุคคลไม่จำเป็นต้องแสดงตนว่าเป็นบริษัท การส่ง SMS/MMS จากแอปพลิเคชันต้องมีการอนุมัติการส่งและการลงทะเบียนที่เกี่ยวข้อง บริการส่วนบุคคลและครอบครัวไม่มี API สำหรับเริ่มต้นการส่งข้อความที่ลูกค้าเข้าถึงได้
| กลุ่ม API | URL พื้นฐาน | การยืนยันตัวตนและผลลัพธ์ |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | ข้อมูลรับรองแบบ Basic ที่ได้รับอนุมัติ โทเคนที่จัดเตรียมให้และมีสิทธิ์ใช้ได้เฉพาะการดำเนินการที่รองรับ ผลลัพธ์เป็น JSON status และ response |
| การลงทะเบียนบริการฉุกเฉิน | https://api.multi.tel/emergency | ข้อมูลรับรองแบบ Basic ที่ได้รับอนุมัติ หรือการเข้าถึงแบบ bearer ที่จัดเตรียมไว้โดยเฉพาะ ผลลัพธ์เป็น JSON code, message และ data |
| การเชื่อมต่อ REST ของพอร์ทัล | โฮสต์และการดำเนินการที่แสดงในเอกสารสำหรับนักพัฒนาของบัญชีของคุณ | ใช้ข้อมูลรับรอง scope และสกีมาที่ระบุไว้ของการดำเนินการนั้น คำขอจากเซสชันของเบราว์เซอร์เป็นช่องทางที่แยกต่างหาก |
ตั้งค่า MULTITEL_API_USERNAME และ MULTITEL_API_PASSWORD ผ่านการกำหนดค่าความลับของเซิร์ฟเวอร์ของคุณก่อนใช้ตัวอย่าง ห้ามฝังค่าเหล่านี้ใน JavaScript ของเบราว์เซอร์สาธารณะ ใน URL หรือในระบบควบคุมซอร์สโค้ด ข้อมูลรับรองเฉพาะจัดการได้ใน การตั้งค่าการเชื่อมต่อ API
เตรียมคำขอ SMS
ใช้หมายเลขผู้ส่งที่ได้รับอนุมัติ เปิดใช้งาน SMS และเป็นของบัญชี พร้อมผู้รับที่ยินยอมรับข้อความ และดำเนินการลงทะเบียน Brand/Campaign หรือยืนยันหมายเลขโทลฟรีตามที่กำหนด ตัวอย่างด้านล่างจะส่งข้อความจริงเมื่อกรอกข้อมูลรับรองและหมายเลขที่ใช้งานได้ ไม่ใช่ sandbox
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"แทนที่ตัวยึดตำแหน่งของผู้ส่งและผู้รับด้วยหมายเลขโทรศัพท์รูปแบบสากลที่รวมรหัสประเทศ โดยใช้เฉพาะตัวเลข สำหรับ MMS ให้ระบุ URL ของสื่อที่รองรับและเข้าถึงได้แบบสาธารณะใน media และตรวจสอบสิทธิ์การใช้ MMS และราคาก่อน
การยอมรับไม่ใช่การส่งถึงผู้รับ
ตรวจสอบทั้งสถานะของแอปพลิเคชันชั้นนอกและผลลัพธ์การส่งข้อความที่ส่งกลับมา บันทึกตัวระบุข้อความที่บริการให้มา และติดตามสถานะการส่งและเหตุการณ์ webhook การส่งคำขอสำเร็จไม่สามารถพิสูจน์ได้ว่าเครื่องของผู้รับได้รับข้อความแล้ว
การเรียกเก็บเงิน SMS คิดตามเซกเมนต์ การเข้ารหัสและความยาวของข้อความอาจทำให้เกิดหลายเซกเมนต์ ค่าใช้จ่ายของสื่อและค่าที่เกี่ยวข้องกับผู้ให้บริการเครือข่ายอาจแตกต่างจาก SMS อ่านราคาขายปัจจุบันของบัญชีก่อนส่ง อย่าลองส่งซ้ำโดยไม่ตรวจสอบเมื่อการส่งหมดเวลา ให้ตรวจสอบผลลัพธ์ที่บันทึกไว้ก่อน
จัดการข้อผิดพลาดและการลองใหม่
- การยืนยันตัวตนหรือสิทธิ์ล้มเหลว
- ตรวจสอบสถานะการเปิดใช้งานของข้อมูลรับรอง API บริการที่ได้รับอนุญาต และข้อจำกัด IP ต้นทาง คุกกี้เซสชันของพอร์ทัลไม่ใช่ข้อมูลรับรองสำหรับการเชื่อมต่อระบบ
- เครดิตไม่เพียงพอหรือยังไม่ผ่านการอนุมัติ
- แก้ไขปัญหายอดคงเหลือของบัญชี การอนุมัติการส่ง หรือข้อกำหนดด้านเอกสารให้เรียบร้อยก่อนดำเนินการซ้ำ
- ไม่มีผลลัพธ์
- ให้ถือว่าสต็อกว่างเปล่าหรือไม่พบชื่อผู้โทรเป็นผลลัพธ์ปกติ อย่าสันนิษฐานว่าหมายเลขที่มีรูปแบบถูกต้องจะรองรับทุกบริการ
- เครือข่ายหมดเวลาหรือบริการขัดข้อง
- สำหรับการอ่านข้อมูล ให้ลองใหม่แบบจำกัดจำนวนครั้งพร้อม backoff ส่วนการซื้อ การส่ง หรือการลงทะเบียน ให้ตรวจสอบสถานะของการดำเนินการก่อน เพราะการลองคำขอที่ได้รับการยอมรับแล้วซ้ำอาจทำให้เกิดการดำเนินการที่คิดค่าบริการซ้ำ
การรองรับ idempotency ขึ้นอยู่กับ API แต่ละกลุ่ม Emergency API รองรับคีย์สำหรับลองใหม่ แต่นั่นไม่ได้ทำให้คำขอ v3 ทั่วไปเป็น idempotent เก็บการประทับเวลา ID ที่ส่งกลับมา และผลตอบกลับที่ปกปิดข้อมูลสำคัญแล้วไว้สำหรับฝ่ายสนับสนุน
ดำเนินการต่อด้วยเอกสารอ้างอิงของบัญชีของคุณ
เอกสารอ้างอิงเมื่อลงชื่อเข้าใช้จะกรองการดำเนินการตามสิทธิ์และบริการที่เปิดใช้งานของคุณ ใช้โฮสต์ ประเภทข้อมูลรับรอง ฟิลด์คำขอ และสคีมาการตอบกลับตามที่ระบุไว้อย่างตรงตัว คอนโซลสามารถดำเนินการจริงได้ รวมถึงการซื้อและการส่งข้อความ