Kirim-OTP-Kustom

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

API ini khusus untuk mengirim kode verifikasi yang sudah Anda buat sebelumnya dan tidak akan menghasilkan kode secara otomatis. Setelah kode dikirim, Anda tidak perlu lagi memanggil API verifikasi untuk validasi.

Jika Anda ingin kode verifikasi dihasilkan oleh platform EngageLab, silakan gunakan EngageLab OTP Send API.

Endpoint

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

Autentikasi

Menggunakan HTTP Basic Authentication. Tambahkan Authorization pada HTTP Header:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritma pembuatan base64_auth_string: 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": "+8618701235678",
    "code": "398210", 
    "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 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 isi template, tetapkan nilainya melalui param_vars, misal untuk template Hi {{name}}, kode verifikasi Anda adalah {{code}}, isi param_vars:{"name":"Bob"}.

Parameter Respons

Respons Berhasil

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

            

Perlu diperhatikan, nilai send_channel yang dikembalikan bukan saluran akhir ke pengguna, melainkan saluran pada tahap saat ini. Misal, jika strategi template diatur fallback WhatsApp ke SMS, API awalnya mengembalikan 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": "gagal mengirim sms"
}

            

Kode Error