Pengiriman OTP Kustom

Jika Anda ingin membuat kode verifikasi sendiri tanpa melalui platform EngageLab, Anda dapat memanggil endpoint ini.

Endpoint ini khusus untuk mengirim kode verifikasi yang telah dibuat sebelumnya, dan tidak membuat kode verifikasi sendiri. Setelah mengirim kode verifikasi, Anda tidak perlu memanggil endpoint verifikasi untuk pemeriksaan.

Jika Anda ingin platform EngageLab membuat kode verifikasi, Anda dapat memanggil endpoint Pengiriman OTP EngageLab.

Endpoint

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

Autentikasi

Lihat Autentikasi untuk memahami cara melakukan autentikasi API.

Contoh request

Header request

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

            

Body request

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

            

Parameter request

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

Penjelasan tentang params

1. Untuk field preset template seperti from_id, jika nilai field params tidak diteruskan, maka saat pengiriman pesan akan digunakan from_id preset template;
2. Jika nilai field params diteruskan, seperti params:{"from_id":"12345"}, maka saat pengiriman pesan, from_id template akan diganti menjadi 12345;
3. Selain itu, untuk field variabel kustom dalam konten template saat pembuatan template, nilainya juga diisi melalui params, misalnya konten template Hi {{name}}, your verify code is {{code}}, maka perlu mengisi parameter params:{"name":"Bob"}
4. Variabel khusus channel Email: Untuk channel Email, mendukung penimpaan dinamis subjek email (subject), nama pengirim (from_name), email pengirim (from_mail), dan lainnya melalui params. Untuk penggunaan lanjutan yang lebih detail, lihat Buat Template - Penggunaan lanjutan variabel template Email.

Parameter respons

Respons sukses

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

            

Perhatikan, nilai**send_channel**yang dikembalikan tidak mewakili channel akhir yang sampai ke pengguna, melainkan hanya mewakili channel yang digunakan pada tahap saat ini; jika strategi template mengonfigurasi channel WhatsApp dan pengirimannya gagal lalu otomatis dikirim ulang melalui channel SMS, maka respons endpoint akan mengembalikan nilai whatsapp, dan setelah beberapa waktu ketika kegagalan terdeteksi, sistem akan menggunakan channel SMS untuk mengirim

Respons gagal

Status code HTTP adalah 4xx atau 5xx, body respons berisi field sebagai berikut:

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

            

Kode error