Tanda SMS

Anda dapat melakukan permintaan, penambahan, dan pembaruan tanda tangan SMS melalui antarmuka berikut.

Permintaan

Mengembalikan informasi dasar tanda tangan SMS.

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

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/signs/10" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
sign_id	ID tanda tangan
sign_name	nama tanda tangan
create_time	waktu pembuatan tanda tangan
update_time	waktu modifikasi tanda tangan

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "sign_id": 10, "sign_name": "shanshan", "create_time": "2021-04-10T10:44:37+0800", "update_time": "2022-06-14T19:20:35+0800" } }

              
              {
    "result": {
        "sign_id": 10,
        "sign_name": "shanshan",
        "create_time": "2021-04-10T10:44:37+0800",
        "update_time": "2022-06-14T19:20:35+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status :400

{ "code": 34010, "message": "tanda tangan tidak ada" }

              
              {
    "code": 34010,
    "message": "tanda tangan tidak ada"
}

Tampilkan blok kode ini di jendela mengambang

Permintaan (Batch)

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

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

Parameter	Tipe	Wajib	Deskripsi
sign_name	string	ya	nama tanda tangan, mendukung pencarian kabur

Contoh Permintaan

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

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
sign_id	ID tanda tangan
sign_name	nama tanda tangan
create_time	waktu pembuatan tanda tangan
update_time	waktu modifikasi tanda tangan

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": [{ "sign_id": 1427, "sign_name": "shanshan", "create_time": "2015-04-10T10:44:37+0800", "update_time": "2016-06-14T19:20:35+0800" }], "count":1, "total":1 }

              
              {
    "result":  [{
        "sign_id": 1427,
        "sign_name": "shanshan",
        "create_time": "2015-04-10T10:44:37+0800",
        "update_time": "2016-06-14T19:20:35+0800"
    }],
    "count":1,
    "total":1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status: 401

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

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

Tampilkan blok kode ini di jendela mengambang

Tambah

Mengembalikan informasi dasar tanda tangan SMS setelah berhasil ditambahkan.

URL

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

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

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

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
sign_name	string	ya	Nama tanda tangan, panjang 2-60 karakter dan tidak boleh mengandung simbol []、【】

Tips：

Maksimal 100 tanda tangan yang bisa dibuat secara online.

Contoh Permintaan

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

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

Tampilkan blok kode ini di jendela mengambang

Deskripsi Nilai Balik

Parameter	Deskripsi
sign_id	ID tanda tangan
sign_name	nama tanda tangan
create_time	waktu pembuatan tanda tangan
update_time	waktu modifikasi tanda tangan

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "result": { "sign_id": 1529, "sign_name": "ccc", "create_time": "2015-04-10T10:44:37+0800", "update_time": "2016-06-14T19:20:35+0800" } }

              
              {
    "result": {
        "sign_id": 1529,
        "sign_name": "ccc",
        "create_time": "2015-04-10T10:44:37+0800",
        "update_time": "2016-06-14T19:20:35+0800"
    }
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status: 400

{ "code": 34005, "message": "sign_name tidak valid" }

              
              {
    "code": 34005,
    "message": "sign_name tidak valid"
}

Tampilkan blok kode ini di jendela mengambang

Ubah

Mengembalikan informasi dasar tanda tangan SMS setelah berhasil diperbarui.

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

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
sign_name	string	ya	Nama tanda tangan, panjang 2-60 karakter dan tidak boleh mengandung simbol []、【】

Contoh Permintaan

curl -X PUT "https://api.sendcloud.net/v1/signs/11617" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>" --header "Content-Type: application/json" --data '{ "sign_name": "ccc" }'

              
              curl -X PUT "https://api.sendcloud.net/v1/signs/11617"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>" 
--header "Content-Type: application/json" 
--data '{
    "sign_name": "ccc"
}'

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Respons-gagal

HTTP Status: 400

{ "code": 34005, "message": "sign_name tidak valid" }

              
              {
    "code": 34005,
    "message": "sign_name tidak valid"
}

Tampilkan blok kode ini di jendela mengambang

Hapus

Mengembalikan informasi dasar apakah penghapusan berhasil.

URL

https://sms.api.engagelab.cc/v1/signs/{sign_id}

              
              https://sms.api.engagelab.cc/v1/signs/{sign_id}

Tampilkan blok kode ini di jendela mengambang

Metode Permintaan HTTP

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://api.sendcloud.net/v1/signs/11617" --header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

              
              curl -X DELETE "https://api.sendcloud.net/v1/signs/11617" 
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"

Tampilkan blok kode ini di jendela mengambang

Contoh Nilai Balik

Respons-berhasil

HTTP Status: 200

{ "count": 1 }

              
              {
    "count": 1
}

Tampilkan blok kode ini di jendela mengambang

Tanda Tangan SMS

Permintaan

URL

Metode Permintaan HTTP

Header Permintaan

Contoh Permintaan

Deskripsi Nilai Balik

Contoh Nilai Balik

Permintaan (Batch)

URL

Metode Permintaan HTTP

Header Permintaan

Deskripsi Parameter

Contoh Permintaan

Deskripsi Nilai Balik

Contoh Nilai Balik

Tambah

URL

Metode Permintaan HTTP

Content-type

Header Permintaan

Deskripsi Parameter

Contoh Permintaan

Deskripsi Nilai Balik

Contoh Nilai Balik

Ubah

URL

Metode Permintaan HTTP

Content-type

Header Permintaan

Deskripsi Parameter

Contoh Permintaan

Contoh Nilai Balik

Hapus

URL

Metode Permintaan HTTP

Header Permintaan

Contoh Permintaan

Contoh Nilai Balik