Pengiriman Pesan Kustom

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

Endpoint

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

Autentikasi

Gunakan Autentikasi Dasar HTTP untuk autentikasi, lalu tambahkan Authorization ke header HTTP:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritme pembentukan base64_auth_string adalah: base64(dev_key:dev_secret)

Format Permintaan

Header Permintaan

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

            

Body Permintaan

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

            

Parameter Permintaan

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

Catatan tentang params

1. Untuk variabel template bawaan seperti {{brand_name}}, {{ttl}}, dan {{pwa_url}}, Anda tidak perlu mengirimkannya. Sistem akan secara otomatis menggantinya dengan konten yang ditentukan saat template dibuat.
2. Jika jenis template adalah kode verifikasi, Anda harus mengirim variabel {{code}}; jika tidak, kesalahan akan dikembalikan.
3. Jika konten template berisi field variabel kustom yang ditentukan saat template dibuat, isi nilainya juga melalui params. Sebagai contoh, untuk konten template Hi {{name}}, your verify code is {{code}}, Anda perlu mengisi parameter params: {"name":"Bob"}.

Contoh Permintaan

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 pemasaran kustom

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

            

Parameter Respons

Respons Berhasil

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

            

Perlu diperhatikan bahwa nilai send_channel yang dikembalikan tidak mewakili saluran akhir yang digunakan untuk mengirim pesan kepada pengguna. Nilai ini hanya menunjukkan saluran yang sedang digunakan saat ini. Sebagai contoh, jika strategi yang dikonfigurasi dalam template menentukan bahwa ketika pengiriman WhatsApp gagal, sistem harus otomatis mencoba ulang melalui saluran SMS, respons API akan mengembalikan whatsapp. Setelah kegagalan pengiriman terdeteksi dalam jangka waktu tertentu, sistem kemudian 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