เอกสาร REST API

REST API สำหรับการโทรฉุกเฉิน

ลงทะเบียนหมายเลขและที่อยู่ที่ใช้บริการ ติดตามสถานะการเปิดใช้งาน และดูแลรักษาระเบียนให้ทันสมัยเมื่อสถานที่เปลี่ยนไป

เปิดเอกสารอ้างอิงเฉพาะบัญชี นักพัฒนาและระบบอัตโนมัติ

เลือก 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

อ่านพื้นที่ให้บริการโดยไม่ต้องลงทะเบียนหมายเลข

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

รองรับ https://api.multitel.net/emergency ด้วย URL พื้นฐานของบริการฉุกเฉินทั้งสองไม่มี /v3 รายการพื้นที่ให้บริการแสดงประเทศที่บริการระหว่างประเทศรองรับ ประเภทหมายเลขที่รองรับ และราคา ส่วนสิทธิ์ใช้ E911 ของอเมริกาเหนือจะตรวจสอบระหว่างการลงทะเบียน

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

ตัวอย่างนี้แสดงเฉพาะโครงสร้างซองข้อมูล ให้อ่านสกีมา data ของแต่ละการดำเนินการใน คู่มือ Emergency API ที่เผยแพร่

ลงทะเบียน ติดตามสถานะ แล้วจึงกำหนดค่าการโทร

สำหรับสหรัฐฯ/แคนาดา และภูมิภาค E911 ของอเมริกาเหนืออื่นที่รองรับ ให้ระบุหมายเลข ที่อยู่ E911 และการรับทราบการให้ความยินยอมที่จำเป็น E911 ของอเมริกาเหนือใช้ได้เฉพาะในสภาพแวดล้อมใช้งานจริงเท่านั้น
สำหรับหมายเลขต่างประเทศที่รองรับและเป็นของคุณ ให้ระบุการอ้างอิงเอกสารที่บันทึกไว้ หรือข้อมูลตัวตนและที่อยู่ของผู้ใช้ปลายทาง ตรวจสอบข้อกำหนดของประเทศและประเภทหมายเลขก่อน
ส่งคำขอ POST /registrations หนึ่งครั้ง Idempotency-Key ที่เป็นทางเลือกใช้ระบุการเปลี่ยนแปลงข้อมูลเชิงตรรกะหนึ่งรายการ ให้เก็บคีย์นี้และเพย์โหลดที่ตรงกันทุกประการไว้ตลอดการลองใหม่
อ่าน GET /registrations/:number ตรวจสอบวงจรสถานะ pending และ actionRequired และแก้ไขสิ่งที่ต้องแก้ไข การได้รับการยอมรับหรืออยู่ในสถานะรอดำเนินการไม่ได้หมายความว่าบริการใช้งานได้แล้ว
หลังจากเปิดใช้งานแล้ว ให้กำหนดค่า caller ID ฉุกเฉินที่ถูกต้องและเส้นทางการหมุนหมายเลขเฉพาะประเทศ ใช้ขั้นตอนการยืนยันแบบไม่ใช่เหตุฉุกเฉินของบริการ

การลงทะเบียนต่างประเทศใน sandbox แยกออกจากระบบจริงและไม่เปิดใช้งานการโทรฉุกเฉินจริง E911 ของอเมริกาเหนือต้องใช้ข้อมูลรับรองของบัญชีหลัก คู่มืออธิบายการรองรับบัญชีย่อยต่างประเทศที่จำกัด

การตั้งค่าและการยืนยันในพอร์ทัล พื้นที่ให้บริการตามประเทศและหมายเลขฉุกเฉิน คู่มือสาธารณะฉบับสมบูรณ์เกี่ยวกับคำขอ ฟิลด์ สถานะ และการลองใหม่

จัดการข้อผิดพลาดและการลองใหม่

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

การรองรับ idempotency ขึ้นอยู่กับ API แต่ละกลุ่ม Emergency API รองรับคีย์สำหรับลองใหม่ แต่นั่นไม่ได้ทำให้คำขอ v3 ทั่วไปเป็น idempotent เก็บการประทับเวลา ID ที่ส่งกลับมา และผลตอบกลับที่ปกปิดข้อมูลสำคัญแล้วไว้สำหรับฝ่ายสนับสนุน

ดำเนินการต่อด้วยเอกสารอ้างอิงของบัญชีของคุณ

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

แคตตาล็อกปลายทาง (endpoint) เฉพาะบัญชี คอนโซล Communications REST เอกสาร OpenAPI สาธารณะของ Communications คู่มือการเชื่อมต่อ OAuth