Pengiriman SMS API

Jika Anda ingin mengotomatisasi pengiriman SMS notifikasi dan pemasaran tanpa membuatnya melalui platform EngageLab, Anda dapat menggunakan API ini. Tentukan ID template SMS dan penerima yang dituju, maka sistem akan secara otomatis mengirimkan SMS berdasarkan isi template tersebut.

Konfigurasi Platform

Sebelum memanggil API, pastikan Anda telah menyelesaikan konfigurasi berikut di konsol SMS EngageLab:

Pengaturan Template SMS: Sebelum memanggil API, kunjungi Halaman Manajemen Template untuk menyesuaikan dan mengirimkan template SMS. Template hanya bisa digunakan setelah disetujui dan Anda memperoleh ID template.

Konfigurasi API Key: Buka Halaman API Key untuk membuat kunci autentikasi API Basic.

Proses Pemanggilan

Ikuti langkah berikut untuk memanggil API pengiriman SMS. Jika ada pertanyaan, silakan hubungi layanan pelanggan.

URL Pemanggilan

POST https://smsapi.engagelab.com/v1/messages

Autentikasi Pemanggilan

Gunakan HTTP Basic Authentication untuk verifikasi. Tambahkan Authorization pada HTTP Header:

              
              Authorization: Basic ${base64_auth_string}

            

Algoritma pembuatan base64_auth_string: base64(dev_key:dev_secret)

Format Permintaan

Header Permintaan

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

            

Body Permintaan

              
              {
    "to": [
        "923700056581"
    ],
    "template": {
        "id": "1233",
        "params": {
            "content": "Kode verifikasi: 039487. Kode ini akan kedaluwarsa dalam 5 menit. Anda sedang mencoba membuat akun Anda."
        }
    }
}

            

Parameter Permintaan

Objek permintaan menggunakan format JSON, pastikan header permintaan menyertakan Content-Type: application/json.

Jika Anda memiliki variabel kustom saat membuat template, silakan isi nilainya di sini. Jika tidak diisi, kunci variabel akan dikirimkan apa adanya, misal {{var1}}.

Penjelasan untuk params

Untuk konten template dengan field variabel kustom, tetapkan nilainya melalui params. Misal, jika isi template: Hi {{name}}, selamat datang di EngageLab, maka params:{"name":"Bob"}.

Contoh Permintaan

1. Mengirim Konten Notifikasi Kustom:

              
              {
    "to": ["+8618701235678"],
    "template": {
        "id": "notification-template",
        "params": {
            "order": "123456"
        }
    }
}

            

2. Mengirim Konten Pemasaran Kustom:

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

            

Respons

Kode status HTTP adalah 200, dan body respons berisi field berikut:

Contoh Sukses (Satu Target)

              
              {
    "plan_id": "1972488990548348928",
    "total_count": 1,
    "accepted_count": 1,
    "message_id": "1972488990804201472"
}

            

Contoh Sukses (Beberapa Target)

              
              {
    "plan_id": "1972484198153367552",
    "total_count": 2,
    "accepted_count": 2
}

            

Contoh Sukses (Tugas Terjadwal)

              
              {
    "plan_id": "1972492618659033088",
    "total_count": 1,
    "accepted_count": 1,
    "schedule_info": {
        "task_id": 1972492621368553472
    }
}

            

Contoh Gagal

              
              {
    "plan_id": "1972490061974913024",
    "total_count": 1,
    "accepted_count": 1,
    "message": "err xxxx",
    "code": 1
}

            

Kesalahan Pengiriman

Kode status HTTP adalah 200, dan body respons berisi field berikut:

              
              {
    "plan_id": "string",
    "total_count": 0,
    "accepted_count": 0,
    "message": "string",
    "code": 0
}

            

Kode Error