ดึงรายละเอียดการกำหนดค่าเทมเพลต

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

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

GET https://smsapi.engagelab.com/v1/template-configs/:templateId

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

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

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

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

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

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

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

เนื้อหาคำขอ

ไม่มี

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

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

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

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

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

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

ฟิลด์	ประเภท	คำอธิบาย
template_id	String	ID เทมเพลต
template_name	String	ชื่อเทมเพลต
template_type	String	ประเภทเทมเพลต: `utility` (ประเภทแจ้งเตือน)、`marketing` (ประเภทการตลาด)
template_content	String	เนื้อหาเทมเพลต
country_codes	String	รหัสประเทศที่ส่งหลัก คั่นด้วยเครื่องหมายจุลภาค
status	Integer	สถานะ: 1-รอการตรวจสอบ, 2-ผ่านการตรวจสอบ, 3-ปฏิเสธการตรวจสอบ
sign_id	String	ID ลายเซ็น (ตัวเลือก)
sign_name	String	ชื่อลายเซ็น (ตัวเลือก)
sign_position	Integer	ตำแหน่งลายเซ็น: 0-ไม่มี, 1-นำหน้า, 2-ต่อท้าย (ตัวเลือก)
sign_status	Integer	สถานะลายเซ็น (ตัวเลือก)
audit_remark	String	หมายเหตุการตรวจสอบ
created_time	Integer	เวลาที่สร้าง (ประทับเวลา Unix)
updated_time	Integer	เวลาที่อัปเดต (ประทับเวลา Unix)

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

{ "template_id": "123456789", "template_name": "เทมเพลตแจ้งเตือนคำสั่งซื้อ", "template_type": "utility", "template_content": "คำสั่งซื้อ {order_no} ของคุณจัดส่งแล้ว คาดว่าจะถึงภายใน {delivery_time}", "country_codes": "CN,US", "status": 2, "sign_id": "987654321", "sign_name": "ชื่อบริษัท", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "template_id": "123456789",
  "template_name": "เทมเพลตแจ้งเตือนคำสั่งซื้อ",
  "template_type": "utility",
  "template_content": "คำสั่งซื้อ {order_no} ของคุณจัดส่งแล้ว คาดว่าจะถึงภายใน {delivery_time}",
  "country_codes": "CN,US",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "ชื่อบริษัท",
  "sign_position": 2,
  "sign_status": 2,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

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

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

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

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

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

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

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

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

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

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

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

invalid templateId: รูปแบบ ID เทมเพลตไม่ถูกต้อง
template config not exist: ไม่มีการกำหนดค่าเทมเพลต

ภาคผนวก

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

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

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

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