เอกสาร 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.multitel.net/v3/getcountries"ผลตอบกลับ v3 ประกอบด้วย status และอาร์เรย์ response รายการประเทศมี isocode, name, countrycode ข้อมูลความสามารถ และ next_function ความพร้อมให้บริการขึ้นอยู่กับบัญชีและสต็อกหมายเลข การที่ประเทศปรากฏในรายการไม่ได้เป็นคำมั่นว่าทุกรหัสนำหน้าหรือทุกประเภทหมายเลขจะมีพร้อมให้ใช้
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}จากการค้นหาไปจนถึงการเปิดใช้งาน
- เลือกประเทศ เขตย่อยเมื่อจำเป็น พื้นที่ และประเภทหมายเลข โดยใช้การดำเนินการด้านภูมิศาสตร์ที่เกี่ยวข้อง
- อ่านราคาค่าติดตั้ง ค่ารายเดือน และค่าใช้งาน จำนวนช่องสัญญาณการโทร ปริมาณที่รวมให้ และข้อกำหนดการลงทะเบียนของหมายเลขที่เลือก
- ส่งเอกสารผู้ใช้ปลายทางที่จำเป็นและตรวจสอบสถานะของเอกสาร หมายเลขอาจอยู่ในสถานะรอดำเนินการจนกว่าจะได้รับอนุมัติ
- สั่งซื้อเพียงครั้งเดียวด้วยการเลือกสต็อกและราคาที่ถูกต้องตรงกัน หากผลตอบกลับไม่แน่นอน ให้ตรวจสอบรายการหมายเลขของคุณก่อนส่งคำสั่งซื้ออีกครั้ง
- กำหนดค่าการกำหนดเส้นทางเสียงและการส่งข้อความแยกจากกัน แล้วทดสอบเส้นทางทั้งหมดที่ตั้งใจใช้
จัดการข้อผิดพลาดและการลองใหม่
- การยืนยันตัวตนหรือสิทธิ์ล้มเหลว
- ตรวจสอบสถานะการเปิดใช้งานของข้อมูลรับรอง API บริการที่ได้รับอนุญาต และข้อจำกัด IP ต้นทาง คุกกี้เซสชันของพอร์ทัลไม่ใช่ข้อมูลรับรองสำหรับการเชื่อมต่อระบบ
- เครดิตไม่เพียงพอหรือยังไม่ผ่านการอนุมัติ
- แก้ไขปัญหายอดคงเหลือของบัญชี การอนุมัติการส่ง หรือข้อกำหนดด้านเอกสารให้เรียบร้อยก่อนดำเนินการซ้ำ
- ไม่มีผลลัพธ์
- ให้ถือว่าสต็อกว่างเปล่าหรือไม่พบชื่อผู้โทรเป็นผลลัพธ์ปกติ อย่าสันนิษฐานว่าหมายเลขที่มีรูปแบบถูกต้องจะรองรับทุกบริการ
- เครือข่ายหมดเวลาหรือบริการขัดข้อง
- สำหรับการอ่านข้อมูล ให้ลองใหม่แบบจำกัดจำนวนครั้งพร้อม backoff ส่วนการซื้อ การส่ง หรือการลงทะเบียน ให้ตรวจสอบสถานะของการดำเนินการก่อน เพราะการลองคำขอที่ได้รับการยอมรับแล้วซ้ำอาจทำให้เกิดการดำเนินการที่คิดค่าบริการซ้ำ
การรองรับ idempotency ขึ้นอยู่กับ API แต่ละกลุ่ม Emergency API รองรับคีย์สำหรับลองใหม่ แต่นั่นไม่ได้ทำให้คำขอ v3 ทั่วไปเป็น idempotent เก็บการประทับเวลา ID ที่ส่งกลับมา และผลตอบกลับที่ปกปิดข้อมูลสำคัญแล้วไว้สำหรับฝ่ายสนับสนุน
ดำเนินการต่อด้วยเอกสารอ้างอิงของบัญชีของคุณ
เอกสารอ้างอิงเมื่อลงชื่อเข้าใช้จะกรองการดำเนินการตามสิทธิ์และบริการที่เปิดใช้งานของคุณ ใช้โฮสต์ ประเภทข้อมูลรับรอง ฟิลด์คำขอ และสคีมาการตอบกลับตามที่ระบุไว้อย่างตรงตัว คอนโซลสามารถดำเนินการจริงได้ รวมถึงการซื้อและการส่งข้อความ