สร้างการกำหนดค่าลายเซ็น

สร้างการกำหนดค่าลายเซ็นใหม่ (Sender ID) สำหรับแสดงตัวระบุผู้ส่งในข้อความ SMS หลังจากสร้างแล้ว ลายเซ็นจะมีสถานะ "รอการตรวจสอบ" และต้องผ่านการตรวจสอบก่อนจึงจะใช้งานได้

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

POST https://smsapi.engagelab.com/v1/sign-configs

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

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

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

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

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

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

เนื้อหาคำขอ

{ "sign_name": "ชื่อบริษัท" }
              
              {
  "sign_name": "ชื่อบริษัท"
}

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

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

พารามิเตอร์ ประเภท ตัวเลือก คำอธิบาย
sign_name String จำเป็น ชื่อลายเซ็น ความยาว 2-60 อักขระ ห้ามมี: []

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

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

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

ฟิลด์ ประเภท คำอธิบาย
sign_id String ID ลายเซ็นที่สร้างขึ้น

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

{ "sign_id": "987654321" }
              
              {
  "sign_id": "987654321"
}

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

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

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

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

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

{ "code": 400, "message": "sign_name already exist" }
              
              {
  "code": 400,
  "message": "sign_name already exist"
}

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

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

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

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

  • sign_name already exist: ชื่อลายเซ็นมีอยู่แล้ว

ข้อควรทราบ

  1. หลังจากสร้างลายเซ็นแล้ว สถานะจะเป็น "รอการตรวจสอบ" (status=1) และต้องผ่านการตรวจสอบก่อนจึงจะใช้งานได้
  2. ชื่อลายเซ็นภายในธุรกิจเดียวกันต้องไม่ซ้ำกัน
  3. ชื่อลายเซ็นต้องไม่มีอักขระต้องห้าม: []
  4. ID ของลายเซ็นเป็นตัวเลขแบบสตริง

ภาคผนวก

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

ค่า คำอธิบาย
1 รอการตรวจสอบ
2 ผ่านการตรวจสอบ
3 ปฏิเสธการตรวจสอบ
Icon Solid Transparent White Qiyu
ติดต่อฝ่ายขาย