เอกสาร REST API

REST API การค้นหาเส้นทาง LRN

ค้นหาหมายเลขเส้นทางและข้อมูลผู้ให้บริการที่มีอยู่สำหรับหมายเลขโทรศัพท์ในอเมริกาเหนือ ในราคาคงที่

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

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

ค้นหาหมายเลข

GET /v3/lrn/{number} รับหมายเลขปลายทางในพาธ สามารถระบุหมายเลขต้นทางเพิ่มเติมเป็น /v3/lrn/{number}/{ani} เพื่อขอข้อมูลที่ขึ้นอยู่กับต้นทาง ใช้หมายเลขโทรศัพท์อเมริกาเหนือโดยระบุเฉพาะตัวเลขและรวมรหัสประเทศตามความเหมาะสม ตัวอย่างใช้หมายเลขสมมติที่สงวนไว้

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123"

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/lrn/12025550123/12025550124"

การค้นหาด้วยข้อมูลรับรองที่ถูกต้องมีค่าใช้จ่าย อัตราคือ US$0.00025 ต่อการค้นหา หรือ US$0.25 ต่อ 1,000 ครั้ง หรือ US$250 ต่อหนึ่งล้านครั้ง ไม่มีส่วนลดตามปริมาณ นี่เป็นการค้นหาข้อมูลการกำหนดเส้นทาง ไม่ได้เป็นการโทรออก

อ่านผลลัพธ์

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": {
    "lrn": "12025550123",
    "ported": 0,
    "ocn": "",
    "lata": "",
    "rc": "",
    "cost": "$0.00025"
  }
}

ตัวอย่างที่สมมติขึ้นนี้แสดงเพียงรูปแบบของผลตอบกลับ ไม่ใช่ผลการกำหนดเส้นทางที่วัดได้จริง ให้ตรวจสอบ status.code ก่อนใช้ response ฟิลด์ cost เป็นสตริงที่มีสกุลเงินนำหน้า ไม่ใช่ตัวเลข JSON

ฟิลด์	ความหมาย
`lrn`	Location Routing Number ที่ใช้ระบุปลายทางของการกำหนดเส้นทาง
`ported`	ตัวบ่งชี้การโอนย้ายหมายเลขที่การค้นหานี้ให้มา โดยทั่วไปเป็น 0 หรือ 1 อย่าใช้เป็นหลักฐานของความเป็นเจ้าของหรือสิทธิ์ในการใช้บริการ
`ocn`	Operating Company Number เมื่อมีให้
`lata`	Local Access and Transport Area เมื่อมีให้
`rc`	Rate center เมื่อมีให้
`city`, `state`, `lec`, `lectype`, `jurisdiction`, `local`	รายละเอียดเพิ่มเติมเกี่ยวกับตำแหน่ง ผู้ให้บริการ หรือต้นทางเมื่อมีข้อมูล รายละเอียดเหล่านี้อาจไม่มีหรือเป็นค่าว่าง

อย่ากำหนดให้ต้องมีฟิลด์การกำหนดเส้นทางครบทุกฟิลด์ โดยเฉพาะผลลัพธ์ของหมายเลขโทลฟรีอาจไม่มีรายละเอียด rate center ท้องถิ่นและรหัสผู้ให้บริการ LRN ที่ส่งกลับมาไม่ได้รับประกันการติดต่อได้แบบเรียลไทม์ และไม่ใช่การทดสอบคุณภาพการโทร

ใช้การค้นหาในเวิร์กโฟลว์การกำหนดเส้นทางของคุณ

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

ดูผลิตภัณฑ์ LRN และราคาแบบคงที่ พาธ OpenAPI สาธารณะมีส่วน ANI ส่วนการใช้งาน LRN ที่ติดตั้งจริงยังรองรับคำขอแบบสั้นที่ไม่มี ANI ด้วย lrninfo เป็นการดำเนินการแยกต่างหาก และไม่ควรใช้แทนเอนด์พอยต์นี้

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

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

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

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

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

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