Kirim

API ini menghasilkan kode verifikasi melalui platform EngageLab dan mengirimkannya sesuai strategi saluran yang diatur pada template.

Jika Anda ingin membuat kode verifikasi sendiri, gunakan EngageLab Custom OTP Send API.

Endpoint

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

Autentikasi

Menggunakan HTTP Basic Authentication. Tambahkan Authorization pada Header HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritma pembuatan base64_auth_string: base64(dev_key:dev_secret)

Contoh Permintaan

Header Permintaan

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

            

Body Permintaan

              
              {
    "to": "+8618701235678",
    "template":{
      "id":"test-template-1",
      "language": "default",
        "params": {
        "key1": "value1",
        "key2": "value2"
        }
    }
}

            

Parameter Permintaan

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

Catatan tentang params

1. Untuk template dengan field preset seperti from_id, jika param_vars tidak diisi, pesan akan menggunakan from_id yang diatur pada template.
2. Jika param_vars diisi, misal param_vars:{"from_id":"12345"}, maka saat pengiriman, from_id pada template akan diganti dengan 12345.
3. Untuk variabel kustom pada konten template, isi nilainya melalui param_vars, misal untuk template Hi {{name}}, your verify code is {{code}}, gunakan param_vars:{"name":"Bob"}.

Parameter Respons

Respons Berhasil

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

            

Catatan: Nilai send_channel yang dikembalikan hanya saluran pada tahap saat ini, bukan saluran akhir ke pengguna. Misal, jika strategi template diatur fallback WhatsApp ke SMS, respons awal API akan menampilkan whatsapp, dan jika gagal, sistem akan mengirim ulang via SMS.

Respons Gagal

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

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

            

Kode Error