Label SMS

Anda dapat melakukan query, menambah, mengubah, dan menghapus label SMS melalui antarmuka berikut.

Query

Mengembalikan informasi dasar label SMS.

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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/labels/598802" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
    "result": 
        {
            "label_id": 598802,
            "label_name": "xjm226",
            "create_time": "2022-11-14T14:27:48+0800",
            "update_time": "2022-11-14T14:27:48+0800"
        }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :400

{ "code": 34020, "message": "label_id harus berupa integer" }

              
              {
  "code": 34020,
  "message": "label_id harus berupa integer"
}

Tampilkan blok kode ini di jendela mengambang

Query (Batch)

Mengembalikan daftar label.

URL

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

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

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
offset	Integer	tidak	posisi offset, [0-], default 0
limit	Integer	tidak	jumlah, [0-100], default 100
label_name	string	tidak	pencarian kabur

Contoh Permintaan

curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" --header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

              
              curl -X GET "https://sms.api.engagelab.cc/v1/labels?label_name=test" 
--header "Authorization: Basic <<YOUR_AUTHORIZATION_KEY>>"

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": [ { "create_time": "2022-11-14T14:27:48+0800", "label_id": 10, "label_name": "test", "update_time": "2022-11-14T14:27:48+0800" } ], "total": 28, "count": 1 }

              
              {
    "result": [
       {
            "create_time": "2022-11-14T14:27:48+0800",
            "label_id": 10,
            "label_name": "test",
            "update_time": "2022-11-14T14:27:48+0800"
        }
    ],
    "total": 28,
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {  
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Tambah

Mengembalikan informasi dasar label SMS setelah berhasil ditambahkan.

URL

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

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

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
label_name	string	ya	nama label yang akan ditambahkan. Maksimal 64 karakter.

Tips

Maksimal pembuatan label adalah 100000.

Contoh Permintaan

curl -X POST "https://sms.api.engagelab.cc/v1/labels" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test2" }'

              
              curl -X POST "https://sms.api.engagelab.cc/v1/labels"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test2"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
label_id	ID label
label_name	nama label
create_time	waktu pembuatan label
update_time	waktu modifikasi label

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "label_id": 11, "label_name": "test", "create_time": "2022-11-14T14:27:48+0800", "update_time": "2022-11-14T14:27:48+0800" } }

              
              {
    "result": {
        "label_id": 11,
        "label_name": "test",
        "create_time": "2022-11-14T14:27:48+0800",
        "update_time": "2022-11-14T14:27:48+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Ubah

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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
label_name	string	ya	nama label baru. Maksimal 64 karakter.

Contoh Permintaan

curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "label_name": "test3" }'

              
              curl -X PUT "https://sms.api.engagelab.cc/v1/labels/11"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "label_name": "test3"
}'

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah label yang diubah

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count":1 }

              
              {
    "count":1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang

Hapus

URL

https://sms.api.engagelab.cc/v1/labels/{label_id}

              
              https://sms.api.engagelab.cc/v1/labels/{label_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/labels/11" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
count	jumlah label yang dihapus

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :401

{ "code": 30000, "message": "Tidak terotorisasi." }

              
              {
    "code": 30000,
    "message": "Tidak terotorisasi."
}

Tampilkan blok kode ini di jendela mengambang