Mengirimkan Template Pesan Media
Template pesan media memperluas konten yang dapat Anda kirim kepada penerima di luar jenis template pesan standar untuk menyertakan media dan header menggunakan objek components. Objek components memungkinkan Anda menunjukkan type dari pesan dan parameters pesan.
 |  |  |
Langkah 1: Buat Permintaan POST ke /messages
POST /v1/messages
{
"to": "recipient_wa_id",
"type": "template",
"template": {
"namespace": "your-namespace",
"language": {
"policy": "deterministic",
"code": "your-language-and-locale-code"
},
"name": "your-template-name",
"components": [
{
"type" : "header",
"parameters": [
# The following parameters code example includes several different possible header types,
# not all are required for a media message template API call.
{
"type": "text",
"text": "replacement_text"
}
# OR
{
"type": "document",
"document": {
"id": "your-media-id",
# filename is an optional parameter
"filename": "your-document-filename"
}
}
# OR
{
"type": "document",
"document": {
"link": "the-provider-name/protocol://the-url",
# provider and filename are optional parameters
"provider": {
"name" : "provider-name"
},
"filename": "your-document-filename"
}
}
# OR
{
"type": "video",
"video": {
"id": "your-media-id"
}
}
# OR
{
"type": "video",
"video": {
"link": "the-provider-name/protocol://the-url"
# provider is an optional parameter
"provider": {
"name" : "provider-name"
}
}
}
# OR
{
"type": "image",
"image": {
"link": "http(s)://the-url",
# provider is an optional parameter
"provider": {
"name" : "provider-name"
},
}
}
]
# end header
},
{
"type" : "body",
"parameters": [
{
"type": "text",
"text": "replacement_text"
},
{
"type": "currency",
"currency" : {
"fallback_value": "$100.99",
"code": "USD",
"amount_1000": 100990
}
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "February 25, 1977",
"day_of_week": 5,
"day_of_month": 25,
"year": 1977,
"month": 2,
"hour": 15,
"minute": 33, #OR
"timestamp": 1485470276
}
},
{
...
# Any additional template parameters
}
]
# end body
},
]
}
}
Parameter
Rekomendasi Format Media
- Gambar yang lebih tinggi dari rasio aspek 1,91:1 dipotong secara vertikal. Untuk berkomunikasi crux dalam gambar-gambar tersebut, berencana untuk menyampaikan informasi paling penting di tengah-tengah gambar.
Langkah 2: Periksa Tanggapan API
Tanggapan yang berhasil mengandung objek messages dengan id.
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
Tanggapan yang gagal berisi objek kesalahan dengan string kesalahan, kode kesalahan, dan informasi lainnya.
Jika template dikirim ke akun yang tidak dapat menerima template tersebut, kesalahan 1026 (ReceiverIncapable) akan dikirim dalam objek kesalahan ke server Webhooks yang dikonfigurasi.
Lihat Kode Kesalahan dan Status untuk informasi selengkapnya tentang kesalahan.
Contoh
Contoh ini menunjukkan proses menyiapkan template pesan media yang dimulai dengan pembuatan template di Pengelola Bisnis Anda dan mengirimkan template pesan dengan panggilan API ke endpoint messages.
Contoh ini hanya diberikan sebagai ilustrasi dan tidak boleh digunakan. Anda harus membuat contoh sendiri dan menyetujuinya untuk menguji fungsi template pesan media.
Contoh tiket bioskop
Contoh ini menunjukkan pembuatan template pesan media dengan gambar kode QR.
1. Buat template pesan media di Pengelola Bisnis Anda.
2. Panggilan API messages ditambahkan dalam informasi parameter.
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "movie_ticket_update",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "image",
"image": {
"id": "your-image-id"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "Star Rangers"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "May 1st, 2019 8:45pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 20,
"minute": 45
}
},
{
"type": "text",
"text": "Carnival, Sangam"
},
{
"type": "text",
"text": "Silver"
},
{
"type": "text",
"text": "F6, F7, F8"
}
]
}
]
}
}
3. Pelanggan Anda menerima pesan tiket bioskop mereka.
Contoh tiket penerbangan
Contoh ini menunjukkan pembuatan template pesan media dengan dokumen PDF.
1. Buat template pesan media di Pengelola Bisnis Anda.
2. Panggilan API messages ditambahkan dalam informasi parameter.
POST /v1/messages
{
"to": "your-test-recipient-wa-id",
"recipient_type": "individual",
"type": "template",
"template": {
"namespace": "88b39973_f0d5_54e1_29cf_e80f1e3da4f2",
"name": "flight_confirmation",
"language": {
"code": "en",
"policy": "deterministic"
},
"components": [
{
"type": "header",
"parameters": [
{
"type": "document",
"document": {
"filename": "MRRATH-CGK-KUL.pdf",
"link": "link-to-your-document"
}
}
]
},
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "CGK (Jakarta)"
},
{
"type": "text",
"text": "KUL (Kuala Lumpur)"
},
{
"type": "date_time",
"date_time" : {
"fallback_value": "20th April 2019, 12:20pm",
"day_of_month": 20,
"year": 2019,
"month": 9,
"hour": 12,
"minute": 10
}
}
]
}
]
}
}
3. Pelanggan Anda menerima boarding pass mereka dalam dokumen PDF.
