นักพัฒนา

POST/v3/number_identity/{number}

ส่งโปรไฟล์การลงทะเบียนหมายเลข

เชื่อมโยงโปรไฟล์การลงทะเบียนที่บันทึกไว้กับหมายเลขที่ซื้อ และขอให้ผู้ให้บริการเครือข่ายตรวจพิจารณาในกรณีที่รองรับ

ในหน้านี้
  1. เตรียมโปรไฟล์ที่บันทึกไว้และหมายเลข
  2. ส่งคำขอเชื่อมโยง
  3. แยกการเชื่อมโยงออกจากการอนุมัติ
  4. จัดการข้อผิดพลาดโดยไม่สร้างงานซ้ำ
  5. ข้อจำกัดของเอกสารแบบใช้ครั้งเดียว
  6. ปกป้องข้อมูลการลงทะเบียน

เตรียมโปรไฟล์ที่บันทึกไว้และหมายเลข

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

ใช้บัญชี MultiTEL API ที่เปิดใช้งานแล้วผ่าน HTTPS โดยใช้ข้อมูลรับรองและข้อจำกัด IP ที่กำหนดไว้ ทั้งโปรไฟล์ที่ยังไม่ถูกลบและหมายเลขที่ซื้อแล้วซึ่งยังไม่ถูกยกเลิกต้องเป็นของบัญชีคุณ

  1. สร้างโปรไฟล์การลงทะเบียน หรือเลือกโปรไฟล์ที่มีอยู่ เก็บ uuid ของโปรไฟล์ภายในระบบที่ได้จาก create_document ไว้ โดย get_document จะส่งค่าการอ้างอิงภายในระบบเดียวกันกลับมาใน id
  2. สำหรับการส่งคำขอผ่านผู้ให้บริการเครือข่าย โปรไฟล์ต้องมีค่าอ้างอิงตัวตนและที่อยู่ที่บันทึกไว้ แนบหลักฐานและเอกสารประกอบที่จำเป็นผ่านขั้นตอนที่เหมาะสมของเอกสารแต่ละประเภทก่อนส่งคำขอ
  3. ตรวจสอบว่าหมายเลขและโปรไฟล์เป็นไปตามข้อกำหนดของประเทศและหมายเลขที่เกี่ยวข้อง อย่าถือว่าโปรไฟล์ที่บันทึกไว้ได้รับอนุมัติให้ใช้กับทุกหมายเลข

ส่งคำขอเชื่อมโยง

curl --silent --show-error --request POST \
  --user "$API_USER:$API_PASSWORD" \
  --form-string document_uuid="$PROFILE_UUID" \
  --form-string service_description="Example customer support line" \
  https://api.multitel.net/v3/number_identity/12125550123

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

ฟิลด์สำหรับส่งการลงทะเบียน
ฟิลด์จำเป็นความหมาย
document_uuidใช่ค่า uuid ที่ตรงกับโปรไฟล์ภายในระบบที่บันทึกไว้ทุกประการ ห้ามใช้ identity_id หรือ address_id ของระบบภายนอกที่ถูกปกปิดค่า รหัสการอัปโหลด หรือค่า registration_details_id ที่ได้รับกลับมาแทน
service_descriptionไม่ใช่คำอธิบายบริการที่ตั้งใจจะใช้ ซึ่งจะถูกส่งต่อเพื่อให้ผู้ให้บริการเครือข่ายตรวจสอบ ระบบจะตัดช่องว่างที่ต้นและท้ายข้อความออก
onetime_filesขึ้นอยู่กับขั้นตอนการดำเนินงานอาร์เรย์ที่รับไว้สำหรับเอกสารแบบใช้ครั้งเดียวของผู้ให้บริการเครือข่าย ตัวจัดการปัจจุบันจะตัดช่องว่างที่ต้นและท้ายของแต่ละสตริงแล้วส่งต่อ โดยไม่แปลงค่าอ้างอิงการอัปโหลดภายในระบบเป็นค่าปลายทาง ยังไม่ได้ยืนยันว่าสามารถใช้ร่วมกับรหัสที่ถูกปกปิดค่าซึ่ง create_encrypt_files ส่งกลับมาได้ โปรดดูข้อจำกัดของเอกสารแบบใช้ครั้งเดียวด้านล่างก่อนใช้ฟิลด์นี้

สำหรับคำขอแบบหลายส่วน อาร์เรย์จะใช้ฟิลด์ onetime_files[] ซ้ำกันหลายครั้ง ระบบยังรับคำขอ JSON ที่มี Content-Type: application/json โดยจะรวมคุณสมบัติของคำขอเข้ากับข้อมูลฟอร์มที่ส่งมา สามารถระบุ number ในข้อมูลที่ส่งได้เมื่อไม่ได้ระบุหมายเลขในพาธ ควรใช้พาธที่ระบุหมายเลขอย่างชัดเจนตามตัวอย่างด้านบนเพื่อหลีกเลี่ยงความกำกวม

แยกการเชื่อมโยงออกจากการอนุมัติ

อ่านทั้งผลลัพธ์ HTTP และ status.code ใน JSON ข้อผิดพลาดใน JSON อาจส่งกลับมาพร้อม HTTP 200 ได้ เมื่อดำเนินการผ่านผู้ให้บริการเครือข่ายสำเร็จ ระบบจะแจ้ง Address verification task created; awaiting carrier review. ตัวอย่างนี้ใช้ค่าอ้างอิงสมมติ

{
  "status": {
    "code": 200,
    "msg": "Address verification task created; awaiting carrier review."
  },
  "response": {
    "number": "+12125550123",
    "did_id": "11111111111111111111111111111111",
    "document_uuid": "0123456789abcdef0123456789abcdef",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "address_verification_id": "44444444444444444444444444444444",
    "verification_status": "pending",
    "verification_reference": null,
    "requirement_id": "55555555555555555555555555555555",
    "registration_details_id": "8516ac99dc60603295de7bdb6a153530"
  }
}

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

หมายเลขที่จัดสรรแล้วบางหมายเลขใช้การเชื่อมโยงตัวตนภายในระบบแทนการสร้างรายการตรวจสอบกับผู้ให้บริการเครือข่าย ผลลัพธ์ที่สำเร็จของหมายเลขเหล่านี้คือ Identity associated. พร้อมอาร์เรย์ response ที่ว่างเปล่า ผลลัพธ์นี้ไม่ได้สร้างงานตรวจพิจารณาของผู้ให้บริการเครือข่ายหรือยืนยันการอนุมัติ พอร์ทัลมีขั้นตอนการเชื่อมโยงรุ่นใหม่กว่า ซึ่งจัดการผู้ให้บริการและตรวจสอบการส่งซ้ำต่างจากเอนด์พอยต์นี้

จัดการข้อผิดพลาดโดยไม่สร้างงานซ้ำ

รหัส API 400 ใช้กับกรณีที่ไม่มีหมายเลขหรือค่าอ้างอิงโปรไฟล์ รหัส 404 ใช้กับกรณีที่บัญชีไม่สามารถใช้โปรไฟล์หรือหมายเลขนั้นได้ หรือไม่มีหมายเลขนั้นในคลังหมายเลขของผู้ให้บริการเครือข่าย รหัส 422 อาจแจ้งว่าไม่มีค่าอ้างอิงตัวตน/ที่อยู่ มีข้อกำหนดของผู้ขาย หรือผู้ให้บริการเครือข่ายปฏิเสธการตรวจสอบ การไม่มีการตั้งค่าการเรียกกลับอาจทำให้เกิดรหัส 503 และความล้มเหลวในการรับส่งข้อมูลขณะสร้างงานอาจทำให้เกิดรหัส 502 อ่านข้อความและ requirement_diagnostics ที่มี แทนที่จะจัดการความล้มเหลวทุกกรณีด้วยวิธีเดียวกัน

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

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

ข้อจำกัดของเอกสารแบบใช้ครั้งเดียว

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

อย่าถือว่าสามารถคัดลอกรหัสไฟล์จาก create_encrypt_files มาใส่ในฟิลด์นี้เพื่อดำเนินขั้นตอนข้อตกลงแบบใช้ครั้งเดียวให้เสร็จสมบูรณ์ได้ เมื่อหมายเลขจำเป็นต้องใช้เอกสารเหล่านี้ ให้ใช้พอร์ทัลหรือยืนยันขั้นตอนการใช้ตัวระบุที่รองรับกับ MultiTEL ส่วนนี้ยังเป็นประเด็นที่ไม่ได้ข้อยุติในการทบทวน API ไม่ใช่ตัวอย่างที่ผ่านการตรวจสอบตั้งแต่ต้นจนจบแล้ว

ปกป้องข้อมูลการลงทะเบียน

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