Pengiriman OTP

API Pengiriman OTP ini menghasilkan kode verifikasi melalui platform EngageLab dan mengirimkannya sesuai strategi saluran yang ditentukan dalam template.

Jika Anda ingin membuat kode verifikasi sendiri alih-alih menggunakan platform EngageLab, Anda dapat memanggil API EngageLab OTP Custom Verification Code Delivery.

Endpoint

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

Autentikasi

Gunakan HTTP Basic Authentication dan tambahkan Authorization ke header HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritme pembentukan base64_auth_string adalah: 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": "+6591234567",
  "template": {
    "id": "test-template-1",
    "language": "default",
    "params": {
      "key1": "value1",
      "key2": "value2"
    }
  }
}

            

Parameter Permintaan

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

Catatan tentang params

1. Untuk field preset dalam template, seperti from_id, jika nilai field param_vars tidak diberikan, maka from_id preset dari template akan digunakan saat pesan dikirim.
2. Jika nilai field param_vars diberikan, seperti param_vars:{"from_id":"12345"}, maka from_id dalam template akan diganti menjadi 12345 saat pesan dikirim.
3. Pada saat yang sama, field variabel kustom dalam konten template yang dibuat saat pembuatan template juga ditetapkan melalui param_vars. Misalnya, jika konten template adalah Hi {{name}}, your verify code is {{code}}, maka parameter param_vars:{"name":"Bob"} diperlukan.

Parameter Respons

Respons Berhasil

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

            

Perlu diperhatikan bahwa nilai send_channel yang dikembalikan tidak merepresentasikan saluran akhir yang digunakan untuk mengirim pesan kepada pengguna. Nilai tersebut hanya menunjukkan saluran yang sedang digunakan saat ini. Misalnya, jika strategi template dikonfigurasi sehingga pengiriman melalui saluran WhatsApp gagal lalu otomatis mencoba ulang melalui saluran SMS, respons API akan mengembalikan nilai whatsapp. Setelah jangka waktu tertentu, begitu kegagalan pengiriman terdeteksi, sistem akan mengirim pesan melalui saluran SMS.

Respons Gagal

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

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

            

Kode Error