Template SMS

Antarmuka berikut memungkinkan Anda menambah, mengubah, menghapus, mencari, mengajukan, dan menyetujui template SMS.

Pencarian

Mengembalikan detail informasi template SMS.

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(sms_user:sms_key)

Contoh Permintaan

curl -X GET "https://sms.api.engagelab.cc/v1/templates/1235" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates/1235" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
template_name	nama template
msg_type	tipe SMS, 2 berarti SMS internasional
template_type	tipe konten SMS, 0 kode verifikasi, 1 notifikasi industri, 2 pemasaran
approval_status	status review, 0 menunggu review, 1 disetujui, -1 gagal, -2 belum diajukan
approval_message	pesan review, hanya ada jika approval_status -1
template_content	isi template, maksimal 512 karakter
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ "result": { "template_id": 123, "template_name": "test", "msg_type": 2, "template_type": 1, "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***", "approval_status": 1, "approval_message": "", "create_time": "2015-03-23T14:27:48+0800", "update_time": "2017-03-29T14:27:48+0800" } }

              
              {
    "result": {
        "template_id": 123,
        "template_name": "test",
        "msg_type": 2,
        "template_type": 1,
        "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***",
        "approval_status": 1,
        "approval_message": "",
        "create_time": "2015-03-23T14:27:48+0800",
        "update_time": "2017-03-29T14:27:48+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status :400

{ "code": 33001, "message": "Template tidak ditemukan" }

              
              {
    "code": 33001,
    "message": "Template tidak ditemukan"
}

Tampilkan blok kode ini di jendela mengambang

Pencarian (Batch)

Mengembalikan informasi dasar template SMS.

URL

https://sms.api.engagelab.cc/v1/templates

              
              https://sms.api.engagelab.cc/v1/templates

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

GET

GET

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter Query

Parameter	Tipe	Wajib	Deskripsi
template_ids	string	tidak	ID template, bisa lebih dari satu, pisahkan dengan koma
approval_status	string	tidak	status review, 0 menunggu review, 1 disetujui, -1 gagal, -2 belum diajukan
template_name	string	tidak	nama template, pencarian kabur
offset	int	tidak	posisi offset, [0-], default 0
limit	int	tidak	jumlah data, [0-100], default 100

Tips:

Pengguna dapat menentukan ID template untuk pencarian. Jika tidak, semua template akan dicari secara default.

Contoh Permintaan

curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/templates?approval_status=1" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
template_name	nama template
msg_type	tipe SMS
template_type	tipe konten SMS
approval_status	status review
approval_message	pesan review, hanya ada jika approval_status -1
template_content	isi template
sign_id	ID tanda tangan
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ "result" : [{ "template_id" : 100, "template_name" : "tset", "msg_type" : 2, "template_type" : 1, "template_content" : "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***", "approval_status" : 1, "approval_message": "", "create_time" : "2016-08-25T14:27:48+0800", "update_time" : "2016-08-25T14:27:48+0800" }], "count":1, "total" : 1 }

              
              {
    "result" :  [{
        "template_id" : 100,
        "template_name" : "tset",
        "msg_type" : 2,
        "template_type" : 1,
        "template_content" : "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***",
        "approval_status" : 1,
        "approval_message": "",
        "create_time" : "2016-08-25T14:27:48+0800",
        "update_time" : "2016-08-25T14:27:48+0800"
    }],
    "count":1,
    "total" : 1
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status: 400

{ "code": 30002, "message": "limit tidak valid" }

              
              {
  "code": 30002,
  "message": "limit tidak valid"
}

Tampilkan blok kode ini di jendela mengambang

Tambah

Mengembalikan informasi apakah penambahan berhasil.

URL

https://sms.api.engagelab.cc/v1/templates

              
              https://sms.api.engagelab.cc/v1/templates

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	string	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
template_name	string	ya	nama template, unik dalam akun, maksimal 64 karakter
template_content	string	ya	isi template tidak boleh mengandung karakter seperti [],【】, test, 测试, maksimal 512 karakter
template_type	string	ya	tipe konten SMS, 0 kode verifikasi, 1 notifikasi industri, 2 pemasaran
msg_type	string	tidak	tipe SMS, 2 berarti SMS internasional, default 2
sign_id	Integer	tidak	ID tanda tangan
sign_pos	string	tidak	posisi tanda tangan, 0 depan, 1 belakang, default 0
submit	bool	tidak	apakah langsung diajukan untuk review, default false

Contoh Permintaan

curl -X POST "https://sms.api.engagelab.cc/v1/templates" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***", "sign_id": 1235, "template_type": "0" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***",
    "sign_id": 1235,
    "template_type": "0"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
template_id	ID template
template_name	nama template
msg_type	tipe SMS
template_type	tipe konten SMS
approval_status	status review
approval_message	pesan review, hanya ada jika approval_status -1
template_content	isi template
sign_id	ID tanda tangan
create_time	waktu pembuatan template
update_time	waktu modifikasi template

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ "result" : { "template_id" : 200, "template_name" : "bill", "msg_type" : 2, "template_type" : 1, "template_content" : "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***", "approval_status" : 1, "approval_message": "", "create_time" : "2022-08-25T14:35:48+0800", "update_time" : "2022-08-25T14:35:48+0800" } }

              
              {
    "result" : {
        "template_id" : 200,
        "template_name" : "bill",
        "msg_type" : 2,
        "template_type" : 1,
        "template_content" : "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***",
        "approval_status" : 1,
        "approval_message": "",
        "create_time" : "2022-08-25T14:35:48+0800",
        "update_time" : "2022-08-25T14:35:48+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status: 400

{ "code": 33006, "message": "Nama template hanya mendukung 64 karakter" }

              
              {
    "code": 33006,
    "message": "Nama template hanya mendukung 64 karakter"
}

Tampilkan blok kode ini di jendela mengambang

Ajukan

Mengembalikan informasi dasar apakah pengajuan berhasil.

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}/submit

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

POST

              
              POST

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Contoh Permintaan

curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/x-www-form-urlencoded"

              
              curl -X POST "https://sms.api.engagelab.cc/v1/templates/3381/submit"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/x-www-form-urlencoded"

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ }

Tampilkan blok kode ini di jendela mengambang

Ubah

Mengembalikan informasi dasar apakah perubahan berhasil.

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

PUT

PUT

Tampilkan blok kode ini di jendela mengambang

Content-type

application/json

              
              application/json

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Deskripsi Parameter

Parameter	Tipe	Wajib	Deskripsi
template_name	string	tidak	nama template, unik dalam akun, maksimal 64 karakter
template_content	string	tidak	isi template tidak boleh mengandung karakter seperti [],【】, test, 测试, maksimal 512 karakter
sign_id	Integer	tidak	ID tanda tangan
sign_pos	string	tidak	posisi tanda tangan, 0 depan, 1 belakang, default 0
template_type	string	tidak	tipe konten SMS, 0 kode verifikasi, 1 notifikasi industri, 2 pemasaran
submit	bool	tidak	apakah langsung diajukan untuk review, default false

Tips：

Setelah memanggil antarmuka ini, perubahan template_name tidak mengubah status persetujuan template, sedangkan perubahan parameter lain akan mengubah status persetujuan template.

Contoh Permintaan

curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "template_name": "test", "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***", "sign_id": 132, "template_type": 0 }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/templates/3381"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "template_name": "test",
    "template_content": "Yth. %name%, jumlah konsumsi Anda di platform bulan ini adalah:***",
    "sign_id": 132,
    "template_type": 0
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ "count": 1 }

              
              { 
 "count": 1 
}

Tampilkan blok kode ini di jendela mengambang

Respon-gagal

HTTP Status: 401

{ "code": 30000, "message": "Autentikasi gagal" }

              
              {
  "code": 30000,
  "message": "Autentikasi gagal"
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://sms.api.engagelab.cc/v1/templates/{template_id}

              
              https://sms.api.engagelab.cc/v1/templates/{template_id}

Tampilkan blok kode ini di jendela mengambang

Metode HTTP Request

DELETE

              
              DELETE

Tampilkan blok kode ini di jendela mengambang

Header Permintaan

Header	Tipe	Wajib	Deskripsi
Authorization	String	ya	Basic base64(sms_user:sms_key)

Contoh Permintaan

curl -X DELETE "https://sms.api.engagelab.cc/v1/templates/3381" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://sms.api.engagelab.cc/v1/templates/3381" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

Respon-berhasil

HTTP Status: 200

{ "count": 1 }

              
              { 
 "count": 1 
}

Tampilkan blok kode ini di jendela mengambang