Kirim
Kirim
Kirim template SMS ke satu atau beberapa pengguna
URL
https://sms.api.engagelab.cc/v1/send
https://sms.api.engagelab.cc/v1/send
Tampilkan blok kode ini di jendela mengambang
Metode Permintaan HTTP
POST
POST
Tampilkan blok kode ini di jendela mengambang
Content-Type
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
Tampilkan blok kode ini di jendela mengambang
Header Permintaan
| Header | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| Authorization | String | ya | Basic base64(sms_user:sms_key) |
Deskripsi Parameter Body
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| from | string | tidak | Nama pengirim, 3-11 karakter, hanya huruf dan angka Inggris. Default kosong, tampil sesuai efek aktual. |
| to | array | ya | Daftar nomor ponsel, maksimal 1000 nomor. |
| body | object | ya | Pengaturan isi SMS |
| template_id | int | ya | ID template |
| msg_type | int | tidak | Tipe SMS, 2 untuk SMS internasional, default 2. |
| label_id | int | tidak | Label SMS |
| vars | object | tidak | Variabel. Maksimal 1MB |
| custom_args | object | tidak | Field opsional yang dikustomisasi pelanggan. Maksimal 1KB. |
| request_id | string | tidak | ID permintaan pengiriman ini; maksimal 128 karakter. |
Tips:
- Vars digunakan untuk penggantian variabel pada isi pesan. Format: objek json, misal '{"varname": ["value1", "value2"]}', varname adalah variabel pada isi pesan.
- Contoh isi pesan: Selamat datang di layanan SMS %sp%. Nilai vars: {"sp": "engagelab"} Hasil: Selamat menggunakan layanan SMS EngageLab.
- Setiap nilai pada vars maksimal 16 karakter, diformat string, dan tidak boleh mengandung link HTTP (hubungi CS untuk kebutuhan khusus).
- Sistem akan mengganti variabel pada template SMS dengan parameter di vars, dan semua nomor ponsel akan menerima isi yang sama setelah diganti.
- custom_args yang Anda definisikan akan disisipkan di header; data SMSHook berikutnya akan dikembalikan ke Anda.
- request_id digunakan untuk mencegah pengiriman ganda, berlaku 1 jam. Jika dikirim ulang dalam 1 jam, hasil terakhir yang dikembalikan.
Contoh Permintaan
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week": "Tuesday"
}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week": "Tuesday"
}
}
}'
Tampilkan blok kode ini di jendela mengambang
Deskripsi Nilai Balik
| Parameter | Deskripsi |
|---|---|
| success_count | jumlah pengiriman yang berhasil |
| sms_ids | daftar ID SMS yang berhasil dikirim |
| failed_count | jumlah pengiriman yang gagal |
| failed_items | daftar nomor gagal beserta alasannya |
| phone | nomor ponsel |
| message | alasan kegagalan |
| request_id | ID permintaan pengiriman ini |
| custom_args | field opsional yang dikustomisasi pelanggan |
Contoh Nilai Balik
Response-sukses
HTTP Status: 200
// contoh hasil pengembalian berhasil
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
// contoh hasil pengembalian sebagian berhasil
{
"code": 41031,
"message": "berhasil sebagian",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Format nomor ponsel tidak valid"
}
]
}
// contoh hasil pengembalian berhasil
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
// contoh hasil pengembalian sebagian berhasil
{
"code": 41031,
"message": "berhasil sebagian",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Format nomor ponsel tidak valid"
}
]
}
Tampilkan blok kode ini di jendela mengambang
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Tidak terotorisasi."
}
{
"code": 30000,
"message": "Tidak terotorisasi."
}
Tampilkan blok kode ini di jendela mengambang
Response-error
HTTP Status :400
// contoh hasil pengembalian gagal
{
"code": 32002,
"message": "Format nomor ponsel tidak valid"
}
// contoh hasil pengembalian gagal
{
"code": 32002,
"message": "Format nomor ponsel tidak valid"
}
Tampilkan blok kode ini di jendela mengambang
