Mendapatkan Detail Konfigurasi Template

Mendapatkan informasi detail konfigurasi template berdasarkan ID template, mencakup nama template, tipe, konten, status peninjauan, dan lainnya.

Alamat Panggilan

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

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

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

Tampilkan blok kode ini di jendela mengambang

Request Body

Tidak ada

Parameter Request

Parameter Path

Parameter	Tipe	Opsi	Penjelasan
templateId	String	Wajib	ID template

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berupa objek konfigurasi template:

Field	Tipe	Deskripsi
template_id	String	ID template
template_name	String	Nama template
template_type	String	Tipe template: `utility` (notifikasi), `marketing` (pemasaran)
template_content	String	Konten template
country_codes	String	Kode negara tujuan pengiriman utama, dipisahkan dengan koma
status	Integer	Status: 1-Menunggu Peninjauan, 2-Lolos Peninjauan, 3-Ditolak
sign_id	String	ID signature (opsional)
sign_name	String	Nama signature (opsional)
sign_position	Integer	Posisi signature: 0-tidak ada, 1-prefiks, 2-sufiks (opsional)
sign_status	Integer	Status signature (opsional)
audit_remark	String	Catatan peninjauan
created_time	Integer	Waktu pembuatan (Unix timestamp)
updated_time	Integer	Waktu pembaruan (Unix timestamp)

Contoh Sukses

{ "template_id": "123456789", "template_name": "Template Notifikasi Pesanan", "template_type": "utility", "template_content": "Pesanan Anda {order_no} telah dikirim, diperkirakan tiba pada {delivery_time}", "country_codes": "CN,US", "status": 2, "sign_id": "987654321", "sign_name": "Nama Perusahaan", "sign_position": 2, "sign_status": 2, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "template_id": "123456789",
  "template_name": "Template Notifikasi Pesanan",
  "template_type": "utility",
  "template_content": "Pesanan Anda {order_no} telah dikirim, diperkirakan tiba pada {delivery_time}",
  "country_codes": "CN,US",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "Nama Perusahaan",
  "sign_position": 2,
  "sign_status": 2,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

Tampilkan blok kode ini di jendela mengambang

Response Gagal

HTTP status code adalah 4xx/5xx, response body berisi field-field berikut:

Field	Tipe	Deskripsi
code	Integer	Kode error
message	String	Detail error

Contoh Error

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

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

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error	http code	Penjelasan
400	400	Error parameter atau error logika bisnis
500	500	Error internal server

Pesan error umum:

invalid templateId: Format ID template salah
template config not exist: Konfigurasi template tidak ada

Lampiran

Status Konfigurasi Template (status)

Nilai	Penjelasan
1	Menunggu Peninjauan
2	Lolos Peninjauan
3	Ditolak

Tipe Template (template_type)

Nilai	Penjelasan
utility	Notifikasi
marketing	Pemasaran