เอกสาร REST API
ส่งคำขอ MultiTEL 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.multitel.net/v3/getbalance"API การสื่อสาร v3 ส่งผลลัพธ์ของแอปพลิเคชันกลับมาภายในเนื้อหา JSON ให้ตรวจสอบสถานะ HTTP และ status.code ก่อนอ่าน response เนื่องจากคำขอที่ถูกปฏิเสธอาจไม่มีออบเจ็กต์ response ค่า code อาจเป็นสตริงหรือตัวเลขก็ได้
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}นี่เป็นตัวอย่างสมมติ ไม่ใช่ยอดคงเหลือของบัญชีจริง ให้ถือว่าค่าเงินเป็นจำนวนทศนิยม และเมื่อวินิจฉัยคำขอที่ถูกปฏิเสธ ให้เก็บข้อความตอบกลับจากเซิร์ฟเวอร์ไว้ โดยลบข้อมูลรับรองความปลอดภัยออกก่อน
ใช้ข้อมูลการเรียกเก็บเงินอย่างถูกต้อง
ผลตอบกลับยอดคงเหลือประกอบด้วยยอดคงเหลือปัจจุบัน สกุลเงิน และเงื่อนไขการชำระเงิน แต่ไม่ได้ระบุค่าใช้จ่ายของการโทรในอนาคตหรือใบแจ้งหนี้ฉบับสมบูรณ์ สำหรับคำถามเหล่านั้นให้ใช้การดำเนินการด้านอัตราค่าบริการและการใช้งานที่เกี่ยวข้อง หมายเลขที่มีอยู่แล้วอาจใช้แผนที่แตกต่างจากแคตตาล็อกในปัจจุบัน
เลือกการเชื่อมต่อถัดไปของคุณ
REST API การค้นหาเส้นทาง LRN
ค้นหาหมายเลขเส้นทางและข้อมูลผู้ให้บริการที่มีอยู่สำหรับหมายเลขโทรศัพท์ในอเมริกาเหนือ ในราคาคงที่
อ่านคู่มือการเชื่อมต่อ →REST API สำหรับหมายเลขโทรศัพท์
ค้นหาประเทศและหมายเลขที่มีให้บริการ ตรวจสอบข้อเสนอทั้งหมด และจัดการหมายเลขที่คุณเป็นเจ้าของ
อ่านคู่มือการเชื่อมต่อ →REST API สำหรับ SMS และ MMS
ส่งข้อความของแอปพลิเคชันที่ได้รับอนุมัติ และจัดการการรับคำขอ เหตุการณ์การนำส่ง การแบ่งเซกเมนต์ และค่าใช้จ่าย
อ่านคู่มือการเชื่อมต่อ →REST API สำหรับการโทรฉุกเฉิน
ลงทะเบียนหมายเลขและที่อยู่ที่ใช้บริการ ติดตามสถานะการเปิดใช้งาน และดูแลรักษาระเบียนให้ทันสมัยเมื่อสถานที่เปลี่ยนไป
อ่านคู่มือการเชื่อมต่อ →REST API สำหรับบัญชีและการเรียกเก็บเงิน
อ่านยอดคงเหลือและข้อมูลการเรียกเก็บเงินที่การเชื่อมต่อที่ได้รับอนุมัติของคุณเข้าถึงได้
อ่านคู่มือการเชื่อมต่อ →การค้นหา CNAM และข้อมูลการกำหนดเส้นทาง
อ่านชื่อผู้โทร ทำความเข้าใจระดับการค้นหา และใช้ข้อมูลการกำหนดเส้นทางหมายเลข
เอกสารอ้างอิง CNAM REST →Hosted PBX
เริ่มจากแผนบริการที่มีให้เลือกและผู้เช่า (tenant) ที่คุณตั้งใจจะกำหนดค่า
API แผนบริการ Hosted PBX →จัดการข้อผิดพลาดและการลองใหม่
- การยืนยันตัวตนหรือสิทธิ์ล้มเหลว
- ตรวจสอบสถานะการเปิดใช้งานของข้อมูลรับรอง API บริการที่ได้รับอนุญาต และข้อจำกัด IP ต้นทาง คุกกี้เซสชันของพอร์ทัลไม่ใช่ข้อมูลรับรองสำหรับการเชื่อมต่อระบบ
- เครดิตไม่เพียงพอหรือยังไม่ผ่านการอนุมัติ
- แก้ไขปัญหายอดคงเหลือของบัญชี การอนุมัติการส่ง หรือข้อกำหนดด้านเอกสารให้เรียบร้อยก่อนดำเนินการซ้ำ
- ไม่มีผลลัพธ์
- ให้ถือว่าสต็อกว่างเปล่าหรือไม่พบชื่อผู้โทรเป็นผลลัพธ์ปกติ อย่าสันนิษฐานว่าหมายเลขที่มีรูปแบบถูกต้องจะรองรับทุกบริการ
- เครือข่ายหมดเวลาหรือบริการขัดข้อง
- สำหรับการอ่านข้อมูล ให้ลองใหม่แบบจำกัดจำนวนครั้งพร้อม backoff ส่วนการซื้อ การส่ง หรือการลงทะเบียน ให้ตรวจสอบสถานะของการดำเนินการก่อน เพราะการลองคำขอที่ได้รับการยอมรับแล้วซ้ำอาจทำให้เกิดการดำเนินการที่คิดค่าบริการซ้ำ
การรองรับ idempotency ขึ้นอยู่กับ API แต่ละกลุ่ม Emergency API รองรับคีย์สำหรับลองใหม่ แต่นั่นไม่ได้ทำให้คำขอ v3 ทั่วไปเป็น idempotent เก็บการประทับเวลา ID ที่ส่งกลับมา และผลตอบกลับที่ปกปิดข้อมูลสำคัญแล้วไว้สำหรับฝ่ายสนับสนุน
ดำเนินการต่อด้วยเอกสารอ้างอิงของบัญชีของคุณ
เอกสารอ้างอิงเมื่อลงชื่อเข้าใช้จะกรองการดำเนินการตามสิทธิ์และบริการที่เปิดใช้งานของคุณ ใช้โฮสต์ ประเภทข้อมูลรับรอง ฟิลด์คำขอ และสคีมาการตอบกลับตามที่ระบุไว้อย่างตรงตัว คอนโซลสามารถดำเนินการจริงได้ รวมถึงการซื้อและการส่งข้อความ