Pengiriman Kode OTP Kustom

Jika Anda ingin membuat kode verifikasi sendiri alih-alih menggunakan kode yang dibuat oleh platform EngageLab, Anda dapat memanggil API ini.

API ini secara khusus digunakan untuk mengirim kode verifikasi yang telah dibuat sebelumnya dan tidak membuat kode verifikasi secara otomatis. Setelah mengirim kode verifikasi, Anda tidak perlu memanggil API verifikasi untuk memvalidasinya.

Jika Anda ingin platform EngageLab membuat kode verifikasi, Anda dapat memanggil API Pengiriman Kode Verifikasi OTP EngageLab.

Endpoint

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

Autentikasi

Gunakan Autentikasi Dasar HTTP dengan menambahkan Authorization ke header HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritme pembentukan base64_auth_string di atas adalah: base64(dev_key:dev_secret)

Contoh Permintaan

Header Permintaan

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

            

Body Permintaan

              
              {
  "to": "+6591234567",
  "code": "398210",
  "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.

Deskripsi params

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

Parameter Respons

Respons Berhasil

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

            

Harap diperhatikan bahwa nilai send_channel yang dikembalikan tidak mewakili saluran akhir yang digunakan untuk mengirimkan pesan kepada pengguna; nilai tersebut hanya mewakili saluran yang sedang digunakan saat ini. Sebagai contoh, jika strategi template dikonfigurasi sehingga pengiriman melalui saluran WhatsApp akan otomatis mencoba ulang melalui saluran SMS jika gagal, maka respons API akan mengembalikan nilai whatsapp. Setelah jangka waktu tertentu, jika kegagalan pengiriman terdeteksi, sistem akan mengirim 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 Kesalahan