Tentukan URL HTTP untuk menerima notifikasi tinjauan templat pesan.
Spesifikasi protokol
Item | Deskripsi |
Protocol | HTTP + JSON |
Encoding method | UTF-8 |
Prasyarat
Anda telah mendaftarkan Akun Alibaba Cloud dan membuat pasangan Kunci Akses. Untuk informasi selengkapnya, lihat Create an AccessKey pair.
Anda telah meninjau overview and configuration of message receipts serta memahami mode, jenis, dan proses konfigurasinya. Selanjutnya, konfigurasikan tanda terima pesan tersebut sesuai kebutuhan.
Request
Beberapa laporan tinjauan dapat didorong sekaligus.
Contoh request
[
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca3****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
},
{
"WabaId": "9099999990****",
"TemplateCode": "744c4b5c79c9432497a075bdfca*****",
"Language": "en_US",
"AuditStatus": "unaudit",
"Reason": ""
}
]Parameter request
V1
Parameter | Type | Required | Deskripsi |
WabaId | String | Yes | WhatsApp Business Account (WABA) ID. Catatan Setelah Anda membuat WABA, peroleh WABA ID di platform Business Manager. |
TemplateCode | String | Yes | Kode templat. Catatan Peroleh kode templat di halaman Template Design pada konsol Chat App Message Service atau dengan memanggil operasi ListChatappTemplate. |
Language | String | Yes | Bahasa templat. |
AuditStatus | String | Yes | Status tinjauan templat pesan. Nilai yang valid:
|
Reason | String | No | Alasan kegagalan peninjauan. Catatan Nilai dikembalikan ketika nilai kembali dari AuditStatus adalah fail. |
V2
V2 digunakan ketika independent software vendor (ISV) perlu mengelola WhatsApp Business accounts (WABAs) dan nomor telepon pelanggannya.
Parameter | Type | Required | Deskripsi |
WabaId | String | Yes | WABA ID. Catatan Setelah Anda membuat WABA, peroleh WABA ID di platform Business Manager. |
TemplateCode | String | Yes | Kode templat. Catatan Peroleh kode templat di halaman Template Design pada konsol Chat App Message Service atau dengan memanggil operasi ListChatappTemplate. |
Language | String | Yes | Bahasa templat. |
AuditStatus | String | Yes | Status tinjauan templat pesan. Nilai yang valid:
|
Reason | String | No | Alasan penolakan tinjauan. Catatan Nilai dikembalikan ketika nilai kembali dari AuditStatus adalah fail. |
Type | String | Yes | Jenis notifikasi. Nilai yang valid:
Catatan Jika nilai kembali Type adalah template, parameter dalam laporan tinjauan V2 sama dengan parameter dalam laporan tinjauan V1. |
PhoneNumber | String | No | Nomor telepon. Catatan
|
Status | String | No | Status. Catatan
|
CurrentLimit | String | No | Jumlah maksimum pesan yang dapat dikirim oleh nomor telepon dalam sehari. Catatan
|
Response
Untuk mengonfirmasi penerimaan callback, titik akhir Anda harus mengembalikan kode status HTTP 200 dalam waktu 3 detik. Badan respons harus berupa objek JSON dalam format berikut. Jika tidak, sistem akan menganggap bahwa laporan tinjauan gagal didorong dan akan mencoba mendorongnya kembali.
Contoh response
{
"code" : 0,
"msg" : "Successful"
}Parameter response
Parameter | Type | Required | Deskripsi |
code | Number | Yes | Kode respons. |
msg | String | No | Deskripsi kode respons. |
Retries
Jika upaya dorong awal gagal, layanan akan mencoba kembali setelah 1 menit dan sekali lagi setelah 5 menit. Upaya dianggap gagal jika titik akhir Anda mengembalikan kode status HTTP selain 200 atau jika permintaan melebihi batas waktu. Setelah tiga kali upaya gagal, layanan akan berhenti mencoba ulang.