Template & ID Pengirim

Dokumen ini menjelaskan antarmuka RESTful API untuk konfigurasi template dan tanda tangan.

Informasi Dasar

• Domain: https://smsapi.engagelab.com
• Metode Autentikasi: Basic Authentication (Base64)
  • Format: Authorization: Basic base64(apikey:apisecret)
  • Contoh: Encode apikey:apisecret ke Base64, lalu tambahkan ke header permintaan.
• Content-Type: application/json

Format Respons

Respons Berhasil

Respons sukses langsung berupa objek data atau array:

              
              {
  "template_id": "123456789",
  "template_name": "Contoh Template"
}

            

Atau respons daftar:

              
              [
  {
    "template_id": "123456789",
    "template_name": "Contoh Template"
  }
]

            

Respons Error

Format respons error:

              
              {
  "code": 400,
  "message": "Deskripsi error"
}

            

Antarmuka Konfigurasi Template

1. Mendapatkan Daftar Template

• Metode: GET
• Path: /v1/template-configs
• Autentikasi: Wajib
• Parameter: Tidak ada

Contoh Respons:

              
              [
  {
    "template_id": "123456789",
    "template_name": "Template Notifikasi Pesanan",
    "template_type": "utility",
    "template_content": "Pesanan Anda {order_no} telah dikirim dan diperkirakan tiba pada {delivery_time}.",
    "country_codes": "CN,US",
    "status": 2,
    "sign_id": "987654321",
    "sign_name": "Nama Perusahaan",
    "sign_position": 2,
    "sign_status": 2,
    "audit_remark": "",
    "created_time": 1699000000,
    "updated_time": 1699000000
  }
]

            

2. Mendapatkan Detail Template

• Metode: GET
• Path: /v1/template-configs/:templateId
• Autentikasi: Wajib

Parameter Path:

• templateId (string, wajib): ID Template

Contoh Respons:

              
              {
  "template_id": "123456789",
  "template_name": "Template Notifikasi Pesanan",
  "template_type": "utility",
  "template_content": "Pesanan Anda {order_no} telah dikirim dan diperkirakan tiba pada {delivery_time}.",
  "country_codes": "CN,US",
  "status": 2,
  "sign_id": "987654321",
  "sign_name": "Nama Perusahaan",
  "sign_position": 2,
  "sign_status": 2,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

            

3. Membuat Template

• Metode: POST
• Path: /v1/template-configs
• Autentikasi: Wajib

Body Permintaan:

              
              {
  "template_name": "Template Notifikasi Pesanan",
  "template_type": "utility",
  "template_content": "Pesanan Anda {order_no} telah dikirim dan diperkirakan tiba pada {delivery_time}.",
  "country_codes": "CN,US",
  "add_signature": true,
  "sign_id": "987654321",
  "sign_position": 2
}

            

Contoh Respons:

              
              {
  "template_id": "123456789"
}

            

4. Memperbarui Template

• Metode: PUT
• Path: /v1/template-configs/:templateId
• Autentikasi: Wajib

Body Permintaan: Sama seperti pembuatan.

Contoh Respons:

              
              {
  "code": 0,
  "message": "success"
}

            

5. Menghapus Template

• Metode: DELETE
• Path: /v1/template-configs/:templateId
• Autentikasi: Wajib

Contoh Respons:

              
              {
  "code": 0,
  "message": "success"
}

            

Antarmuka Konfigurasi Tanda Tangan

1. Mendapatkan Daftar Tanda Tangan

• Metode: GET
• Path: /v1/sign-configs
• Autentikasi: Wajib

Contoh Respons:

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

            

2. Mendapatkan Detail Tanda Tangan

• Metode: GET
• Path: /v1/sign-configs/:signId
• Autentikasi: Wajib

Contoh Respons:

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

            

3. Membuat Tanda Tangan

• Metode: POST
• Path: /v1/sign-configs
• Autentikasi: Wajib

Body Permintaan:

              
              {
  "sign_name": "Nama Perusahaan"
}

            

Contoh Respons:

              
              {
  "sign_id": "987654321"
}

            

4. Memperbarui Tanda Tangan

• Metode: PUT
• Path: /v1/sign-configs/:signId
• Autentikasi: Wajib

Body Permintaan: Sama seperti pembuatan.

Contoh Respons:

              
              {
  "code": 0,
  "message": "success"
}

            

5. Menghapus Tanda Tangan

• Metode: DELETE
• Path: /v1/sign-configs/:signId
• Autentikasi: Wajib

Contoh Respons:

              
              {
  "code": 0,
  "message": "success"
}

            

Kode Status & Error

Pesan Error Umum:

• invalid templateId: Format ID template tidak valid.
• template config not exist: Template tidak ditemukan.
• invalid signId: Format ID tanda tangan tidak valid.
• sign config not exist: Tanda tangan tidak ditemukan.
• sign_name already exist: Nama tanda tangan sudah ada.
• can not update pending status template: Template menunggu review tidak dapat diperbarui.
• can not update pending status sign: Tanda tangan menunggu review tidak dapat diperbarui.
• there are pending or running plans using current template, can not update: Ada rencana pesan menunggu/berjalan menggunakan template, tidak dapat diperbarui.
• there are pending or running plans using current sign, can not update: Ada rencana pesan menunggu/berjalan menggunakan tanda tangan, tidak dapat diperbarui.
• sign status is not approved, can not use: Status tanda tangan belum disetujui, tidak dapat digunakan.

Catatan

1. Semua antarmuka wajib autentikasi.
2. Semua antarmuka otomatis terkait businessId pengguna.
3. Operasi pembuatan dan pembaruan template/tanda tangan memicu proses review.
4. Jika template/tanda tangan digunakan oleh rencana pesan menunggu/berjalan, tidak dapat diperbarui atau dihapus.
5. Konten template tidak boleh mengandung: 【, 】, 、, 测试, test, [, ].
6. Nama tanda tangan tidak boleh mengandung: 【, 】, [, ].
7. ID template dan tanda tangan berupa string numerik.