Envoi de modèles de message multimédia
Les modèles de message multimédia permettent d’envoyer davantage de types de contenus à vos destinataires en plus des types standard, dont des médias et des en-têtes utilisant un objet components. L’objet components permet d’indiquer le type de message et de préciser les parameters de celui-ci.
 |  |  |
Étape 1 : envoyer une requête POST à /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
},
]
}
}
Paramètres
Recommandation sur le format du contenu multimédia
- Les images dont les proportions sont supérieures à 1.91:1 sont rognées verticalement. Afin d’aller à l’essentiel en utilisant de telles images, prévoyez de présenter les informations les plus importantes au centre de l’image.
Étape 2 : vérifier la réponse de l’API
Une réponse positive comprend un objet messages avec un id.
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
Une réponse négative comprend un objet erreur contenant une chaîne d’erreur, un code d’erreur et des informations complémentaires.
Si un modèle est envoyé à un compte incapable de recevoir le modèle, l’erreur 1026 (ReceiverIncapable) sera envoyée dans l’objet erreur au serveur Webhook configuré.
Pour plus d’informations sur les erreurs, consultez l’article Codes d’erreur et d’état.
Exemples
Ces exemples illustrent le processus de configuration des modèles de message multimédia. Commencez par créer le modèle dans votre Business Manager, puis envoyez les modèles de message à l’aide d’appels d’API au point de terminaison des messages.
Ces exemples ne sont donnés qu’à titre d’illustration et ne peuvent pas être utilisés. Vous devez créer vos propres exemples et les faire approuver afin de vérifier que le modèle de message multimédia fonctionne.
Exemple de billet de cinéma
Cet exemple illustre la création d’un modèle de message multimédia associé à une image de code QR.
1. Créez le modèle de message multimédia dans votre Business Manager.
2. L’appel d’API des messages est ajouté aux informations de paramètres.
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. Votre client ou cliente reçoit le message associé au billet de cinéma.
Exemple de billet d’avion
Cet exemple illustre la création d’un modèle de message multimédia associé à un document PDF.
1. Créez le modèle de message multimédia dans votre Business Manager.
2. L’appel d’API des messages est ajouté aux informations de paramètres.
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. Votre client ou cliente reçoit son billet d’embarquement sous la forme d’un document PDF.
