Membuat Konfigurasi Signature

Membuat konfigurasi signature baru (Sender ID), digunakan untuk menampilkan identitas pengirim pada SMS. Setelah dibuat, status signature adalah "Menunggu Peninjauan" dan baru dapat digunakan setelah lolos peninjauan.

Alamat Panggilan

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

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

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

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

Tampilkan blok kode ini di jendela mengambang

Request Body

{ "sign_name": "Nama Perusahaan" }

              
              {
  "sign_name": "Nama Perusahaan"
}

Tampilkan blok kode ini di jendela mengambang

Parameter Request

Parameter	Tipe	Opsi	Penjelasan
sign_name	String	Wajib	Nama signature, panjang 2-60 karakter, tidak boleh mengandung: `【`、`】`、`[`、`]`

Parameter Response

Response Sukses

HTTP status code adalah 200, response body berisi field-field berikut:

Field	Tipe	Deskripsi
sign_id	String	ID signature yang dibuat

Contoh Sukses

{ "sign_id": "987654321" }

              
              {
  "sign_id": "987654321"
}

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": 400, "message": "sign_name already exist" }

              
              {
  "code": 400,
  "message": "sign_name already exist"
}

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

Pesan error umum:

sign_name already exist: Nama signature sudah ada

Catatan Penting

Setelah signature dibuat, statusnya adalah "Menunggu Peninjauan" (status=1) dan baru dapat digunakan setelah lolos peninjauan
Nama signature tidak boleh duplikat dalam bisnis yang sama
Nama signature tidak boleh mengandung karakter terlarang: 【、】、[、]
ID signature bertipe angka dalam bentuk string

Lampiran

Status Konfigurasi Signature (status)

Nilai	Penjelasan
1	Menunggu Peninjauan
2	Lolos Peninjauan
3	Ditolak