Memperbarui Konfigurasi Template

Memperbarui konfigurasi template yang sudah ada, mendukung perubahan nama template, tipe, konten, negara tujuan pengiriman, dan informasi signature. Setelah diperbarui, status template akan kembali menjadi "Menunggu Peninjauan".

Alamat Panggilan

PUT https://smsapi.engagelab.com/v1/template-configs/:templateId

Verifikasi Panggilan

Silakan lihat Verifikasi Panggilan untuk mengetahui cara melakukan autentikasi API.

Contoh Request

Request Header

              
              PUT /v1/template-configs/123456789  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            

Request Body

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

            

Parameter Request

Parameter Path

Parameter Request Body

Parameter Response

Response Sukses

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

Contoh Sukses

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

            

Response Gagal

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

Contoh Error

              
              {
  "code": 400,
  "message": "can not update pending status template"
}

            

Kode Error

Pesan error umum:

• invalid templateId: Format ID template salah
• template config not exist: Konfigurasi template tidak ada
• can not update pending status template: Template berstatus menunggu peninjauan tidak dapat diperbarui
• there are pending or running plans using current template, can not update: Terdapat plan menunggu kirim atau sedang berjalan yang menggunakan template ini, tidak dapat diperbarui
• sign config not exist: Konfigurasi signature tidak ada
• sign status is not approved, can not use: Status signature belum lolos peninjauan, tidak dapat digunakan

Catatan Penting

1. Template berstatus menunggu peninjauan tidak dapat diperbarui
2. Jika terdapat plan pesan menunggu kirim atau sedang berjalan yang menggunakan template ini, maka tidak dapat diperbarui
3. Setelah diperbarui, status template akan kembali menjadi "Menunggu Peninjauan" (status=1)
4. Jika menambahkan signature, signature tersebut harus berstatus lolos peninjauan
5. Konten template tidak boleh mengandung karakter terlarang: 【、】、、、测试、test、[、]
6. ID template dan signature keduanya bertipe angka dalam bentuk string

Lampiran

Status Konfigurasi Template (status)

Tipe Template (template_type)

Posisi Signature (sign_position)