Membuat Konfigurasi Template

Membuat konfigurasi template baru, mendukung pengaturan nama template, tipe, konten, negara tujuan pengiriman, dan informasi signature. Setelah dibuat, status template adalah "Menunggu Peninjauan" dan baru dapat digunakan setelah lolos peninjauan.

Alamat Panggilan

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

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

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

Tampilkan blok kode ini di jendela mengambang

Request Body

{ "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", "add_signature": true, "sign_id": "987654321", "sign_position": 2 }

              
              {
  "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",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

Tampilkan blok kode ini di jendela mengambang

Parameter Request

Parameter	Tipe	Opsi	Penjelasan
template_name	String	Wajib	Nama template, maksimal 255 karakter
template_type	String	Wajib	Tipe template: `authentication` (autentikasi/OTP)、`utility` (notifikasi)、`marketing` (pemasaran); nilai lama `otp` akan dipetakan ke `authentication` untuk kompatibilitas
template_content	String	Wajib	Konten template, tidak boleh mengandung: `【`、`】`、`、`、`测试`、`test`、`[`、`]`
country_codes	String	Wajib	Kode negara tujuan pengiriman utama, dipisahkan dengan koma
add_signature	Boolean	Opsional	Apakah menambahkan signature, default false
sign_id	String	Wajib bersyarat	Wajib saat add_signature bernilai true, ID signature
sign_position	Integer	Wajib bersyarat	Wajib saat add_signature bernilai true, posisi signature: 1-prefiks, 2-sufiks

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berisi field-field berikut:

Field	Tipe	Deskripsi
template_id	String	ID template yang dibuat

Contoh Sukses

{ "template_id": "123456789" }

              
              {
  "template_id": "123456789"
}

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": "sign status is not approved, can not use" }

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

Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error	Status HTTP	Kemungkinan Error
`1000`	`500`	Error internal layanan; gagal mengambil daftar/detail template; operasi database gagal saat membuat, memperbarui, atau menghapus template; gagal mengambil informasi signature atau rencana pengiriman tertunda
`2001`	`401`	Autentikasi gagal; `Authorization` tidak ada, format salah, atau token tidak valid
`2002`	`401/403`	Token developer kedaluwarsa atau dinonaktifkan; bisnis telah dihapus
`2005`	`400`	IP tidak ada di daftar putih: `ip forbidden`
`3001`	`400`	Format JSON permintaan tidak benar: `not correct parameter format`
`3002`	`400`	Format `templateId` salah; `template_name` kosong atau lebih dari 255 karakter; `template_type` tidak valid; `template_content` kosong; `country_codes` kosong; `sign_id` tidak ada saat `add_signature=true`; `sign_position` tidak valid; konten template mengandung karakter terlarang
`3002`	`400`	Validasi template tipe autentikasi gagal: harus mengandung `{{code}}` dan hanya mendukung dua variabel `{{code}}` dan `{{ttl}}`
`3003`	`400`	Signature yang ditambahkan belum lolos peninjauan; template bukan milik bisnis saat ini; template yang masih menunggu peninjauan tidak dapat diperbarui; ada rencana tertunda atau yang sedang berjalan menggunakan template ini, sehingga tidak dapat diperbarui/dihapus
`4001`	`400`	Template tidak ada: `template config not exist`; signature yang direferensikan tidak ada saat membuat/memperbarui template: `sign config not exist`

Pesan error umum:

sign config not exist: Konfigurasi signature tidak ada
sign status is not approved, can not use: Status signature belum lolos peninjauan, tidak dapat digunakan
template config not exist: Konfigurasi template tidak ada
ip forbidden: IP tidak ada di daftar putih
not correct parameter format: Format JSON permintaan tidak benar

Catatan Penting

Setelah template dibuat, statusnya adalah "Menunggu Peninjauan" (status=1) dan baru dapat digunakan untuk mengirim SMS setelah lolos peninjauan
Jika menambahkan signature, signature tersebut harus berstatus lolos peninjauan
Konten template tidak boleh mengandung karakter terlarang: 【、】、、、测试、test、[、]
ID template dan signature keduanya bertipe angka dalam bentuk string

Lampiran

Status Konfigurasi Template (status)

Nilai	Penjelasan
1	Menunggu Peninjauan
2	Lolos Peninjauan
3	Ditolak

Tipe Template (template_type)

Nilai	Penjelasan
authentication	Autentikasi/OTP
utility	Notifikasi
marketing	Pemasaran

Nilai lama otp akan dipetakan ke authentication untuk kompatibilitas. Konten template tipe autentikasi harus mengandung {{code}} dan hanya mendukung dua variabel {{code}} dan {{ttl}}.

Posisi Signature (sign_position)

Nilai	Penjelasan
0	Tanpa signature
1	Prefiks
2	Sufiks