นักพัฒนา

POST/v3/create_supporting_document

แนบเอกสารประกอบ

เชื่อมโยงไฟล์ประกอบที่อัปโหลดตามแม่แบบกับข้อมูลประจำตัว

ในหน้านี้
  1. แนบเอกสารประกอบตามแม่แบบ
  2. สร้างเอกสารประกอบ
  3. เอกสารประกอบที่สร้างแล้ว
  4. ข้อผิดพลาดและการลองใหม่

แนบเอกสารประกอบตามแม่แบบ

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

สร้างเอกสารประกอบ

ใช้บัญชี API ของ MultiTEL ที่เปิดใช้งานแล้ว และที่อยู่ IP ที่ได้รับอนุญาตสำหรับบัญชีนั้น ตัวอย่างใช้ข้อมูลรับรองสำหรับ HTTP Basic จากตัวแปรสภาพแวดล้อม ให้ปฏิบัติตามรูปแบบการยืนยันตัวตนสำหรับประเภทบัญชีของคุณ ส่งคำขอผ่าน HTTPS ตรวจสอบทั้งการตอบกลับ HTTP และค่าฟิลด์ใน JSON ต่อไปนี้: status.code; ข้อผิดพลาดของแอปพลิเคชันอาจส่งกลับมาพร้อมรหัส HTTP 200 ได้ ตัวอย่างด้านล่างเป็นข้อมูลสมมติ

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document
{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}
ฟิลด์ของคำขอ
ฟิลด์ความหมาย
identity_idต้องระบุรหัสของข้อมูลประจำตัวที่เชื่อมโยงกับบัญชีของคุณ คำขอนี้แนบเอกสารกับข้อมูลประจำตัว ไม่ได้แนบกับที่อยู่หรือหมายเลขโทรศัพท์โดยตรง
template_idต้องระบุรหัสแม่แบบเอกสารประกอบ โดยใช้แม่แบบเดียวกับที่เลือกไว้ตอนอัปโหลดไฟล์ประกอบ ฟิลด์สำหรับการแนบคือ template_id ส่วนฟิลด์สำหรับการอัปโหลดคือ supporting_template_id
encrypted_file_idsต้องระบุอาร์เรย์ JSON ที่ไม่ว่าง ซึ่งมีรหัสไฟล์อัปโหลดที่ระบบส่งกลับมา ไฟล์แต่ละรายการต้องเป็นของบัญชีปัจจุบัน ยังไม่หมดอายุ และอยู่ในหมวดหมู่ supporting_documents

ระบบยังยอมรับข้อมูลฟอร์มที่ระบุฟิลด์ encrypted_file_ids[] ซ้ำหลายครั้งได้ด้วย ห้ามส่งข้อมูลไบต์ของไฟล์ไปยังปลายทางสำหรับแนบเอกสารนี้

เอกสารประกอบที่สร้างแล้ว

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

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

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

รหัส API 500 หมายถึงข้อมูลนำเข้าไม่ครบ ข้อผิดพลาดจากผู้ให้บริการโทรคมนาคม หรือการตอบกลับจากผู้ให้บริการโทรคมนาคมที่ไม่ถูกต้อง รหัส 404 หมายถึงข้อมูลประจำตัวไม่ได้เชื่อมโยงกับบัญชี แม่แบบไม่ถูกต้อง ไฟล์อัปโหลดขาดหาย หมดอายุ หรืออยู่ผิดหมวดหมู่ หรือไม่มีไฟล์ที่ใช้งานได้ ให้ตรวจสอบ status.msg; รหัส HTTP 200 เพียงอย่างเดียวไม่เพียงพอ

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