Pengiriman Pesan Kustom

Jika Anda telah membuat konten template kustom di platform OTP, panggil endpoint ini untuk mengirim konten pesan kustom.

Endpoint

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

Autentikasi

Lihat Autentikasi untuk memahami cara melakukan autentikasi API.

Format request

Header request

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

            

Body request

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"test-template-1",
      "params": {
        "code": "codevalue",
        "var1":"value1"
        }
    }
}

            

Parameter request

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

Penjelasan tentang params

1. Untuk variabel preset template seperti {{brand_name}}, {{ttl}}, {{pwa_url}}, tidak perlu diteruskan, sistem akan otomatis menggantinya dengan konten yang ditentukan saat pembuatan template;
2. Jika tipe template adalah kode verifikasi, maka variabel {{code}} wajib diteruskan, jika tidak akan menimbulkan error;
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.

Contoh request

1. Mengirim kode verifikasi kustom:

              
              {
    "to": "+6591234567", 
    "template":{
      "id":"code-template",
      "params": {
        "code": "123456"        
        }
    }
}

            

2. Mengirim konten notifikasi kustom:

              
              {
    "to": "+6591234567",
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

3. Mengirim konten marketing kustom:

              
              {
    "to": ["+6591234567"],
    "template": {
        "id": "marketing-template",
        "params": {
            "name": "EngageLab",
            "promotion": "30%"
        }
    }
}

            

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