Logo Site EngageLab Mark Colored TransparentDokumen
Cari

Mendapatkan Daftar Konfigurasi Signature

Mendapatkan daftar semua konfigurasi signature pada bisnis saat ini, mengembalikan daftar yang berisi nama signature, status peninjauan, jumlah template terkait, dan informasi lainnya.

Alamat Panggilan

GET https://smsapi.engagelab.com/v1/sign-configs

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

GET /v1/sign-configs HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              GET /v1/sign-configs  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Tampilkan blok kode ini di jendela mengambang

Request Body

Tidak ada

Parameter Request

Tidak ada

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berupa array konfigurasi signature:

Field Tipe Deskripsi
sign_id String ID signature
sign_name String Nama signature
status Integer Status: 1-Menunggu Peninjauan, 2-Lolos Peninjauan, 3-Ditolak
related_template_count Integer Jumlah template terkait
audit_remark String Catatan peninjauan
created_time Integer Waktu pembuatan (Unix timestamp)
updated_time Integer Waktu pembaruan (Unix timestamp)

Contoh Sukses

[ { "sign_id": "987654321", "sign_name": "Nama Perusahaan", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 } ]
              
              [
  {
    "sign_id": "987654321",
    "sign_name": "Nama Perusahaan",
    "status": 2,
    "related_template_count": 5,
    "audit_remark": "",
    "created_time": 1699000000,
    "updated_time": 1699000000
  }
]

            
Tampilkan blok kode ini di jendela mengambang

Response Gagal

HTTP status code adalah 4xx/5xx, response body berisi field-field berikut:

Field Tipe Deskripsi
code Integer Kode error
message String Detail error

Contoh Error

{ "code": 500, "message": "Error internal server" }
              
              {
  "code": 500,
  "message": "Error internal server"
}

            
Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Error http code Penjelasan
400 400 Error parameter atau error logika bisnis
500 500 Error internal server

Lampiran

Status Konfigurasi Signature (status)

Nilai Penjelasan
1 Menunggu Peninjauan
2 Lolos Peninjauan
3 Ditolak
Icon Solid Transparent White Qiyu
Hubungi Sales