ดึงรายละเอียดการกำหนดค่าลายเซ็น

ดึงข้อมูลรายละเอียดการกำหนดค่าลายเซ็นตาม ID ลายเซ็น รวมถึงชื่อลายเซ็น สถานะการตรวจสอบ จำนวนเทมเพลตที่เชื่อมโยง เป็นต้น

URL สำหรับเรียกใช้

GET https://smsapi.engagelab.com/v1/sign-configs/:signId

การยืนยันตัวตนในการเรียกใช้

โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธียืนยันตัวตน API

ตัวอย่างคำขอ

ส่วนหัวของคำขอ

GET /v1/sign-configs/987654321 HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/sign-configs/987654321  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

โค้ดนี้โชว์เป็นหน้าต่างลอย

เนื้อหาคำขอ

ไม่มี

พารามิเตอร์ของคำขอ

พารามิเตอร์ของเส้นทาง (Path)

พารามิเตอร์	ประเภท	ตัวเลือก	คำอธิบาย
signId	String	จำเป็น	ID ลายเซ็น

พารามิเตอร์ที่ส่งกลับ

การตอบกลับเมื่อสำเร็จ

รหัสสถานะ HTTP เป็น 200 เนื้อหาการตอบกลับเป็นออบเจ็กต์การกำหนดค่าลายเซ็น:

ฟิลด์	ประเภท	คำอธิบาย
sign_id	String	ID ลายเซ็น
sign_name	String	ชื่อลายเซ็น
status	Integer	สถานะ: 1-รอการตรวจสอบ, 2-ผ่านการตรวจสอบ, 3-ปฏิเสธการตรวจสอบ
related_template_count	Integer	จำนวนเทมเพลตที่เชื่อมโยง
audit_remark	String	หมายเหตุการตรวจสอบ
created_time	Integer	เวลาที่สร้าง (ประทับเวลา Unix)
updated_time	Integer	เวลาที่อัปเดต (ประทับเวลา Unix)

ตัวอย่างเมื่อสำเร็จ

{ "sign_id": "987654321", "sign_name": "ชื่อบริษัท", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "ชื่อบริษัท",
  "status": 2,
  "related_template_count": 5,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

การตอบกลับเมื่อล้มเหลว

รหัสสถานะ HTTP เป็น 4xx/5xx เนื้อหาการตอบกลับมีฟิลด์ดังนี้:

ฟิลด์	ประเภท	คำอธิบาย
code	Integer	รหัสข้อผิดพลาด
message	String	รายละเอียดข้อผิดพลาด

ตัวอย่างข้อผิดพลาด

{ "code": 400, "message": "invalid signId" }

              
              {
  "code": 400,
  "message": "invalid signId"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

รหัสข้อผิดพลาด

รหัสข้อผิดพลาด	http code	คำอธิบาย
400	400	พารามิเตอร์ผิดพลาดหรือข้อผิดพลาดทางตรรกะธุรกิจ
500	500	ข้อผิดพลาดภายในเซิร์ฟเวอร์

ข้อความข้อผิดพลาดที่พบบ่อย:

invalid signId: รูปแบบ ID ลายเซ็นไม่ถูกต้อง
sign config not exist: ไม่มีการกำหนดค่าลายเซ็น

ภาคผนวก

สถานะการกำหนดค่าลายเซ็น (status)

ค่า	คำอธิบาย
1	รอการตรวจสอบ
2	ผ่านการตรวจสอบ
3	ปฏิเสธการตรวจสอบ