นักพัฒนา

POST/v3/get_requirements

อ่านข้อกำหนดการลงทะเบียน

เรียกดูข้อกำหนดการลงทะเบียนที่ระบบส่งกลับในปัจจุบันสำหรับประเทศและชื่อประเภทหมายเลข

ในหน้านี้
  1. เลือกประเทศและประเภทหมายเลข
  2. อ่านคำแนะนำที่ส่งกลับมา
  3. อย่าตีความข้อผิดพลาดว่าเป็นการยกเว้น
  4. คำขอ
  5. การตอบกลับ
  6. ข้อผิดพลาด
  7. ความพร้อมใช้งานและผลข้างเคียง

เลือกประเทศและประเภทหมายเลข

เลือกประเทศที่จะลงทะเบียน จากนั้นใช้ชื่อที่ส่งกลับมาจาก get_document_number_types ส่งชื่อนั้นเป็นค่าของ number_type ไม่ใช่ ID ประเภทหรือหมวดหมู่การค้นหาหมายเลขทั่วไป

อ่านคำแนะนำที่ส่งกลับมา

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

อย่าตีความข้อผิดพลาดว่าเป็นการยกเว้น

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

คำขอ

ใช้ข้อมูลรับรองของบัญชี API ที่เปิดใช้งานแล้วผ่าน HTTPS รองรับการยืนยันตัวตนแบบ Basic และโทเค็น bearer ของบัญชี API ที่เปิดใช้งานแล้ว ทั้งนี้ข้อจำกัดของบัญชียังคงมีผลบังคับใช้

POST ด้วย application/json หรือ application/x-www-form-urlencoded

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"
พารามิเตอร์ในส่วนเนื้อหา
ชื่อประเภทจำเป็นคำอธิบาย
countryสตริงใช่รหัส ISO ของประเทศจาก get_document_countries
number_typeสตริงใช่ชื่อประเภทจาก get_document_number_types เช่น Local การจับคู่ไม่คำนึงถึงตัวพิมพ์ใหญ่หรือเล็ก ให้ระบุชื่อ ไม่ใช่ ID ของประเภทนั้น

การตอบกลับ

ตรวจสอบ status.code ในเนื้อหา JSON ควบคู่กับสถานะ HTTP response เป็นทรัพยากรข้อกำหนดรายการเดียวที่มี id, type และ attributes พร้อมด้วย relationships เมื่อมีการส่งกลับ ID ในทรัพยากรและข้อมูลความสัมพันธ์เป็นค่าทึบที่ไม่ควรตีความ ข้อความ restriction_message ซึ่งเป็นตัวเลือกจะถูกลบแท็ก HTML ออกแล้ว ให้จัดการข้อความที่เหลือเป็นข้อความธรรมดา ไม่ใช่ HTML ที่เชื่อถือได้ ตัวจัดการจะส่งกลับทรัพยากรข้อกำหนดรายการแรก ดังนั้นอย่าสรุปว่าการตอบกลับนี้เป็นรายการที่ครบถ้วน ความพร้อมใช้งานของแอตทริบิวต์/ความสัมพันธ์ขึ้นอยู่กับประเทศและประเภท ตัวอย่างนี้ไม่ใช่สคีมาคงที่ที่สมบูรณ์

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

ข้อผิดพลาด

  • 400: การตรวจสอบความถูกต้องของประเทศและ number_type ล้มเหลว: ให้ระบุค่าที่จำเป็นทั้งสองค่า ข้อความการตรวจสอบอาจมีการจัดรูปแบบ
  • 400: Invalid country ISO or No country registration documents required.: ข้อความที่กำกวมนี้ไม่ได้พิสูจน์โดยลำพังว่าได้รับการยกเว้นการลงทะเบียน
  • 400: Invalid number type: ให้ใช้ชื่อประเภทที่ส่งกลับมา ข้อผิดพลาดแบบเดิมแสดงรายการ Global, Local, Mobile, National, Shared Cost และ Toll Free
  • 500: Unable to load registration requirements for the specified country and number type.: ไม่สามารถส่งกลับข้อกำหนดได้สำเร็จ ให้ลองใหม่ภายหลังหรือติดต่อฝ่ายสนับสนุน

ความพร้อมใช้งานและผลข้างเคียง

  • การค้นหาแค็ตตาล็อก/ข้อกำหนดนี้ไม่ได้สร้างข้อมูลระบุตัวตน ไม่ได้อัปโหลดหลักฐาน ไม่ได้ลงทะเบียนหมายเลข และไม่ได้สั่งซื้อ
  • การตอบกลับแค็ตตาล็อกที่สำเร็จไม่ใช่การอนุมัติเอกสารของคุณ และไม่ใช่การยืนยันว่าหมายเลขที่เลือกสามารถเปิดใช้งานได้