สร้างการกำหนดค่าเทมเพลต

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

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

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

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

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

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

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

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

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

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

เนื้อหาคำขอ

{ "template_name": "เทมเพลตแจ้งเตือนคำสั่งซื้อ", "template_type": "utility", "template_content": "คำสั่งซื้อ {order_no} ของคุณจัดส่งแล้ว คาดว่าจะถึงภายใน {delivery_time}", "country_codes": "CN,US", "add_signature": true, "sign_id": "987654321", "sign_position": 2 }

              
              {
  "template_name": "เทมเพลตแจ้งเตือนคำสั่งซื้อ",
  "template_type": "utility",
  "template_content": "คำสั่งซื้อ {order_no} ของคุณจัดส่งแล้ว คาดว่าจะถึงภายใน {delivery_time}",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

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

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

พารามิเตอร์	ประเภท	ตัวเลือก	คำอธิบาย
template_name	String	จำเป็น	ชื่อเทมเพลต สูงสุด 255 อักขระ
template_type	String	จำเป็น	ประเภทเทมเพลต: `authentication` (ยืนยันตัวตน/OTP)、`utility` (ประเภทแจ้งเตือน)、`marketing` (ประเภทการตลาด); ค่าเดิม `otp` จะถูกแมปเป็น `authentication` เพื่อความเข้ากันได้
template_content	String	จำเป็น	เนื้อหาเทมเพลต ต้องไม่มี: `【`、`】`、`、`、`测试`、`test`、`[`、`]`
country_codes	String	จำเป็น	รหัสประเทศที่ส่งหลัก คั่นด้วยเครื่องหมายจุลภาค
add_signature	Boolean	ไม่บังคับ	เพิ่มลายเซ็นหรือไม่ ค่าเริ่มต้นเป็น false
sign_id	String	จำเป็นตามเงื่อนไข	จำเป็นเมื่อ add_signature เป็น true คือ ID ลายเซ็น
sign_position	Integer	จำเป็นตามเงื่อนไข	จำเป็นเมื่อ add_signature เป็น true คือ ตำแหน่งลายเซ็น: 1-นำหน้า, 2-ต่อท้าย

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

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

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

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

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

{ "template_id": "123456789" }

              
              {
  "template_id": "123456789"
}

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

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

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

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

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

{ "code": 400, "message": "sign status is not approved, can not use" }

              
              {
  "code": 400,
  "message": "sign status is not approved, can not use"
}

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

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

รหัสข้อผิดพลาด	สถานะ HTTP	ข้อผิดพลาดที่อาจเกิดขึ้น
`1000`	`500`	ข้อผิดพลาดภายในของบริการ; การค้นหารายการเทมเพลต/รายละเอียดล้มเหลว; การดำเนินการฐานข้อมูลล้มเหลวขณะสร้าง อัปเดต ลบเทมเพลต; การค้นหาข้อมูลลายเซ็นหรือแผนที่รอส่งล้มเหลว
`2001`	`401`	การยืนยันตัวตนล้มเหลว; ขาด `Authorization`, รูปแบบไม่ถูกต้อง หรือโทเค็นไม่ถูกต้อง
`2002`	`401/403`	โทเค็นของนักพัฒนาหมดอายุหรือถูกปิดใช้งาน; ธุรกิจถูกลบแล้ว
`2005`	`400`	IP ไม่อยู่ในรายการที่อนุญาต: `ip forbidden`
`3001`	`400`	รูปแบบ JSON ของคำขอไม่ถูกต้อง: `not correct parameter format`
`3002`	`400`	รูปแบบ `templateId` ไม่ถูกต้อง; `template_name` ว่างหรือยาวเกิน 255 อักขระ; `template_type` ไม่ถูกต้อง; `template_content` ว่าง; `country_codes` ว่าง; ขาด `sign_id` เมื่อ `add_signature=true`; `sign_position` ไม่ถูกต้อง; เนื้อหาเทมเพลตมีอักขระต้องห้าม
`3002`	`400`	การตรวจสอบเทมเพลตประเภทยืนยันตัวตนล้มเหลว: ต้องมี `{{code}}` และรองรับเฉพาะตัวแปร `{{code}}`、`{{ttl}}` สองตัวเท่านั้น
`3003`	`400`	ลายเซ็นที่เพิ่มยังไม่ผ่านการตรวจสอบ; เทมเพลตไม่อยู่ในธุรกิจปัจจุบัน; เทมเพลตที่รอการตรวจสอบไม่สามารถอัปเดต; มีแผนที่รอส่งหรือกำลังทำงานใช้เทมเพลตนี้ ไม่สามารถอัปเดต/ลบได้
`4001`	`400`	ไม่มีเทมเพลต: `template config not exist`; ลายเซ็นที่อ้างอิงไม่มีเมื่อสร้าง/อัปเดตเทมเพลต: `sign config not exist`

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

sign config not exist: ไม่มีการกำหนดค่าลายเซ็น
sign status is not approved, can not use: สถานะลายเซ็นยังไม่ผ่านการตรวจสอบ ไม่สามารถใช้งานได้
template config not exist: ไม่มีการกำหนดค่าเทมเพลต
ip forbidden: IP ไม่อยู่ในรายการที่อนุญาต
not correct parameter format: รูปแบบ JSON ของคำขอไม่ถูกต้อง

ข้อควรทราบ

หลังจากสร้างเทมเพลตแล้ว สถานะจะเป็น "รอการตรวจสอบ" (status=1) และต้องผ่านการตรวจสอบก่อนจึงจะใช้ส่ง SMS ได้
หากเพิ่มลายเซ็น ลายเซ็นจะต้องอยู่ในสถานะผ่านการตรวจสอบแล้ว
เนื้อหาเทมเพลตต้องไม่มีอักขระต้องห้าม: 【、】、、、测试、test、[、]
ID ของทั้งเทมเพลตและลายเซ็นเป็นตัวเลขแบบสตริง

ภาคผนวก

สถานะการกำหนดค่าเทมเพลต (status)

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

ประเภทเทมเพลต (template_type)

ค่า	คำอธิบาย
authentication	ยืนยันตัวตน/OTP
utility	ประเภทแจ้งเตือน
marketing	ประเภทการตลาด

ค่าเดิม otp จะถูกแมปเป็น authentication เพื่อความเข้ากันได้ เนื้อหาเทมเพลตประเภทยืนยันตัวตนต้องมี {{code}} และรองรับเฉพาะตัวแปร {{code}} และ {{ttl}} เท่านั้น

ตำแหน่งลายเซ็น (sign_position)

ค่า	คำอธิบาย
0	ไม่มีลายเซ็น
1	นำหน้า
2	ต่อท้าย