Logo Site EngageLab Mark Colored TransparentDokumen
Cari

Dapatkan Detail Template

Endpoint

GET https://otp.api.engagelab.cc/v1/template-configs/{templateId}

Autentikasi

Lihat Autentikasi untuk memahami cara melakukan autentikasi API.

Request

Parameter request

{templateId} pada URL menunjukkan ID template yang akan diambil, ID template ini didefinisikan sendiri oleh pemanggil saat memanggil endpoint pembuatan template.

Contoh request

Header request

GET /v1/template-configs/{templateId} HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              GET /v1/template-configs/{templateId}  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Tampilkan blok kode ini di jendela mengambang

Body request

Tidak ada

Respons

Parameter respons

Mengembalikan objek JSON berisi informasi konfigurasi detail template.

Contoh respons

Respons sukses

{ "template_id": "test-template-1", // ID template kustom, unik dalam aplikasi "description": "Template uji 1", // deskripsi penjelasan template ini "send_channel_strategy": "whatsapp|sms", // strategi pengiriman template, mendukung empat jenis whatsapp/sms/voice/email, untuk strategi kombinasi gunakan karakter | untuk menandakan pengiriman ulang saat gagal "brand_name": "Nama merek", // nama merek, digunakan pada signature konten template di beberapa negara/wilayah (misalnya beberapa negara/wilayah pada channel SMS mewajibkan registrasi signature) "verify_code_config": { // konfigurasi kode verifikasi, untuk mengonfigurasi kode verifikasi yang dibuat otomatis, dikembalikan ketika template menyertakan tipe kode verifikasi "verify_code_type": 1, // tipe kode verifikasi, rentang nilai [1,7] "verify_code_len": 6, // panjang kode verifikasi, rentang nilai [4,10] "verify_code_ttl": 1 // masa berlaku kode verifikasi, rentang nilai [1,10], perhatikan ketika strategi menyertakan whatsapp nilainya hanya boleh 1, 5, 10 }, "whatsapp_config": { // konfigurasi strategi whatsapp, dikembalikan ketika strategi pengiriman menyertakan whatsapp "template_type": 1 // tipe template whatsapp, saat ini hanya mendukung template default, yaitu selalu 1 }, "sms_config": { // konfigurasi strategi sms, dikembalikan ketika strategi pengiriman menyertakan sms "template_type": 2, // tipe template sms, nilai: 1-template default/2-template kustom "template_parts": 1, // perkiraan jumlah segmen penagihan template sms, jika template terlalu panjang maka harga spesifik = jumlah segmen penagihan * tarif penagihan per unit "template_custom_config": { // konfigurasi template kustom sms, berlaku ketika tipe template sms adalah template kustom "custom_sub_type": "authentication", // tipe template kustom, nilai: authentication-kode verifikasi/marketing-marketing/utility-notifikasi "custom_content": "xxx" // konten template kustom, perhatikan jika sub-tipe adalah authentication (kode verifikasi) maka harus menyertakan variabel {{code}} } }, "voice_config": { // konfigurasi strategi voice, dikembalikan ketika strategi pengiriman menyertakan voice "template_type": 1 // tipe template voice, saat ini hanya mendukung template default, yaitu selalu 1 }, "email_config": { // konfigurasi strategi email, dikembalikan ketika strategi pengiriman menyertakan email "template_name": "nama template email", // nama template email "template_custom_configs": [{ // konfigurasi template kustom email, berlaku ketika tipe template email adalah template kustom, perhatikan ini adalah array objek, terutama untuk mengonfigurasi beberapa entri yang dibedakan melalui language "language": "default", // bahasa, default adalah bahasa default, saat pengiriman pesan dapat mencocokkan konten template berbeda berdasarkan parameter language "pre_from_name": "test", // nama pengirim yang telah ditentukan "pre_from_mail": "test@test.com", // email pengirim yang telah ditentukan "pre_subject": "test", // subjek email yang telah ditentukan "template_content": "Konten template email yang telah ditentukan, wajib, variabel kustom seperti {{self}}, kode verifikasinya adalah {{code}}", // konten email, mendukung html, variabel harus diapit dengan dua kurung kurawal {{}} "pre_param_map": { // nilai default variabel dalam konten email, yaitu jika nilai variabel tidak ditentukan saat pengiriman, maka nilai default berikut digunakan untuk menggantikan variabel, dideklarasikan sebagai pasangan key-value "self": "Ini nilai default variabel self" } }] }, "pwa_config": { // konfigurasi terkait pwa, hanya dikembalikan jika memiliki konfigurasi pwa "pwa_platform": "xx", // platform pwa yang digunakan "pwa_code": "xx" // kode pada platform pwa yang digunakan }, "created_time": 1234567890, // waktu pembuatan template ini, format timestamp, presisi hingga detik "status": 1, // status template, nilai: 1-menunggu peninjauan/2-disetujui/3-ditolak "audit_remark": "xx" // catatan peninjauan, umumnya saat ditolak Anda dapat melihat field ini untuk keterangan alasan penolakan }
              
              {
    "template_id": "test-template-1",       // ID template kustom, unik dalam aplikasi
    "description": "Template uji 1",                 // deskripsi penjelasan template ini
    "send_channel_strategy": "whatsapp|sms",    // strategi pengiriman template, mendukung empat jenis whatsapp/sms/voice/email, untuk strategi kombinasi gunakan karakter | untuk menandakan pengiriman ulang saat gagal
    "brand_name": "Nama merek",                   // nama merek, digunakan pada signature konten template di beberapa negara/wilayah (misalnya beberapa negara/wilayah pada channel SMS mewajibkan registrasi signature)
    "verify_code_config": {                     // konfigurasi kode verifikasi, untuk mengonfigurasi kode verifikasi yang dibuat otomatis, dikembalikan ketika template menyertakan tipe kode verifikasi
        "verify_code_type": 1,                  // tipe kode verifikasi, rentang nilai [1,7]
        "verify_code_len": 6,                   // panjang kode verifikasi, rentang nilai [4,10]
        "verify_code_ttl": 1                    // masa berlaku kode verifikasi, rentang nilai [1,10], perhatikan ketika strategi menyertakan whatsapp nilainya hanya boleh 1, 5, 10
    },
    "whatsapp_config": {                        // konfigurasi strategi whatsapp, dikembalikan ketika strategi pengiriman menyertakan whatsapp
        "template_type": 1                      // tipe template whatsapp, saat ini hanya mendukung template default, yaitu selalu 1
    },
    "sms_config": {                             // konfigurasi strategi sms, dikembalikan ketika strategi pengiriman menyertakan sms
        "template_type": 2,                     // tipe template sms, nilai: 1-template default/2-template kustom
        "template_parts": 1,                    // perkiraan jumlah segmen penagihan template sms, jika template terlalu panjang maka harga spesifik = jumlah segmen penagihan * tarif penagihan per unit
        "template_custom_config": {             // konfigurasi template kustom sms, berlaku ketika tipe template sms adalah template kustom
            "custom_sub_type": "authentication",    // tipe template kustom, nilai: authentication-kode verifikasi/marketing-marketing/utility-notifikasi
            "custom_content": "xxx"                // konten template kustom, perhatikan jika sub-tipe adalah authentication (kode verifikasi) maka harus menyertakan variabel {{code}}
        }
    },
    "voice_config": {                           // konfigurasi strategi voice, dikembalikan ketika strategi pengiriman menyertakan voice
        "template_type": 1                      // tipe template voice, saat ini hanya mendukung template default, yaitu selalu 1
    },
    "email_config": {                           // konfigurasi strategi email, dikembalikan ketika strategi pengiriman menyertakan email
        "template_name": "nama template email",                     // nama template email
        "template_custom_configs": [{           // konfigurasi template kustom email, berlaku ketika tipe template email adalah template kustom, perhatikan ini adalah array objek, terutama untuk mengonfigurasi beberapa entri yang dibedakan melalui language
            "language": "default",              // bahasa, default adalah bahasa default, saat pengiriman pesan dapat mencocokkan konten template berbeda berdasarkan parameter language
            "pre_from_name": "test",            // nama pengirim yang telah ditentukan
            "pre_from_mail": "test@test.com",   // email pengirim yang telah ditentukan
            "pre_subject": "test",              // subjek email yang telah ditentukan
            "template_content": "Konten template email yang telah ditentukan, wajib, variabel kustom seperti {{self}}, kode verifikasinya adalah {{code}}",    // konten email, mendukung html, variabel harus diapit dengan dua kurung kurawal {{}}
            "pre_param_map": {                  // nilai default variabel dalam konten email, yaitu jika nilai variabel tidak ditentukan saat pengiriman, maka nilai default berikut digunakan untuk menggantikan variabel, dideklarasikan sebagai pasangan key-value
                "self": "Ini nilai default variabel self"
            }
        }]
    },
    "pwa_config": {                             // konfigurasi terkait pwa, hanya dikembalikan jika memiliki konfigurasi pwa
        "pwa_platform": "xx",                   // platform pwa yang digunakan
        "pwa_code": "xx"                        // kode pada platform pwa yang digunakan
    },
    "created_time": 1234567890,                 // waktu pembuatan template ini, format timestamp, presisi hingga detik
    "status": 1,                                 // status template, nilai: 1-menunggu peninjauan/2-disetujui/3-ditolak
    "audit_remark": "xx"                        // catatan peninjauan, umumnya saat ditolak Anda dapat melihat field ini untuk keterangan alasan penolakan
}

            
Tampilkan blok kode ini di jendela mengambang

Respons gagal

{ "code": 4001, "message": "config not exist" }
              
              {
    "code": 4001,
    "message": "config not exist"
}

            
Tampilkan blok kode ini di jendela mengambang

Kode error

Kode error http code Keterangan
1000 500 Error internal
2001 401 Autentikasi gagal, tidak menyertakan token yang benar
2002 401 Autentikasi gagal, token telah kedaluwarsa atau dinonaktifkan
2004 403 Tidak memiliki izin untuk memanggil API ini
4001 400 Template tidak ada
Icon Solid Transparent White Qiyu
Hubungi Sales