Senden von Vorlagen für Mediennachrichten
Mit Vorlagen für Mediennachrichten kannst du mehr Inhalte an Empfänger senden, als mit dem Standard-Nachrichtenvorlagentyp möglich ist, nämlich Medien und Kopfzeilen. Hierzu verwendest du ein components-Objekt. Mit dem components-Objekt kannst du den type der Nachricht sowie die parameters der Nachricht angeben.
 |  |  |
Schritt 1: POST-Anfrage an /messages senden
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
Empfohlenes Medienformat
- Bilder mit einem Seitenverhältnis größer als 1,91:1 werden vertikal zugeschnitten. Um das Wesentliche in solchen Bildern zu vermitteln, solltest du die wichtigsten Informationen in der Mitte des Bildes präsentieren.
Schritt 2: API-Antwort prüfen
Eine erfolgreiche Antwort beinhaltet ein messages-Objekt mit einer id.
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
Wenn der Vorgang fehlschlägt, enthält die Antwort ein Fehlerobjekt, das eine Fehlerzeichenfolge, einen Fehlercode und andere Informationen umfasst.
Wenn eine Vorlage an ein Konto gesendet wird, das die Vorlage nicht empfangen kann, wird der Fehler 1026 (ReceiverIncapable) im Fehlerobjekt an den konfigurierten Webhook-Server gesendet.
Weitere Informationen zu Fehlern findest du unter Fehler- und Statuscodes.
Beispiele
In diesen Beispielen wird demonstriert, wie Vorlagen für Mediennachrichten eingerichtet werden. Am Anfang stehen die Vorlagenerstellung in deinem Business Manager und das Senden der Nachrichtenvorlagen mit API-Aufrufen an den messages-Endpunkt.
Die Beispiele dienen lediglich Demonstrationszwecken und können nicht verwendet werden. Zum Testen der Funktionalität der Vorlagen für Mediennachrichten musst du eigene Beispiele erstellen und sie genehmigen lassen.
Beispiel Kinoeintrittskarte
Dieses Beispiel zeigt die Erstellung einer Vorlage für Mediennachrichten mit einem QR-Code-Bild.
1. Erstelle die Vorlage für Mediennachrichten in deinem Business Manager.
2. Der messages-API-Aufruf fügt die Parameterinformationen ein.
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. Dein Kunde erhält die Nachricht mit der Kinoeintrittskarte.
Beispiel Flugticket
Dieses Beispiel zeigt die Erstellung einer Vorlage für Mediennachrichten mit einem PDF-Dokument.
1. Erstelle die Vorlage für Mediennachrichten in deinem Business Manager.
2. Der messages-API-Aufruf fügt die Parameterinformationen ein.
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. Dein Kunde erhält die Bordkarte in einem PDF-Dokument.
