Kirim Pesan Kustom

Jika Anda telah membuat konten template khusus di platform OTP, gunakan API ini untuk mengirimkan konten pesan kustom.

Endpoint API

POST https://otp.api.engagelab.cc/v1/custom-messages

Autentikasi

Menggunakan HTTP Basic Authentication untuk verifikasi. Tambahkan header Authorization pada permintaan HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

base64_auth_string dihasilkan dengan algoritma: base64(dev_key:dev_secret)

Format Permintaan

Header Permintaan

              
              POST /v1/custom-messages HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Body Permintaan

              
              {
    "to": "+8618701235678", 
    "template":{
      "id":"test-template-1",
      "params": {
        "code": "codevalue",
        "var1":"value1"
        }
    }
}

            

Parameter Permintaan

Objek permintaan dalam format JSON, pastikan header permintaan menyertakan Content-Type: application/json.

Catatan tentang params:

• Untuk variabel preset template seperti {{brand_name}}, {{ttl}}, dan {{pwa_url}}, tidak perlu mengirimkan nilai—sistem akan otomatis menggantinya sesuai pengaturan template.
• Jika tipe template adalah kode verifikasi, variabel {{code}} wajib dikirimkan; jika tidak, akan terjadi error.
• Untuk variabel kustom yang Anda definisikan di konten template, masukkan nilainya melalui params. Misal, jika isi template: Hai {{name}}, kode verifikasi Anda adalah {{code}}, maka params:{"name":"Bob"} harus dikirimkan.

Contoh Permintaan

1. Mengirim kode verifikasi khusus:

              
              {
    "to": "+8618701235678", 
    "template":{
      "id":"code-template",
      "params": {
        "code": "123456"        
        }
    }
}

            

2. Mengirim notifikasi khusus:

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Mengirim konten pemasaran khusus:

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

Parameter Respons

Respons Berhasil

              
              {
    "message_id": "1725407449772531712",
    "send_channel": "sms"
}

            

Catatan: Nilai send_channel yang dikembalikan tidak menunjukkan channel akhir ke pengguna, hanya channel yang digunakan pada tahap saat ini. Misalnya, jika strategi template dikonfigurasi fallback ke SMS setelah WhatsApp gagal, API awalnya mengembalikan whatsapp; jika gagal, sistem otomatis beralih ke SMS.

Respons Gagal

Kode status http 4xx atau 5xx, body respons berisi field berikut:

              
              {
    "code": 5001,
    "message": "sms send fail"
}