Enviar modelos de mensagem de mídia
Os modelos de mensagem de mídia expandem o conteúdo que pode ser enviado ao irem além do modelo-padrão de mensagem para incluir mídias e cabeçalhos com o objeto components. O objeto components permite que você informe type e parameters da mensagem.
 |  |  |
Etapa 1: fazer uma solicitação POST para /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
},
]
}
}
Parâmetros
Recomendações sobre formatos de mídia
- Imagens com taxa de proporção mais alta que 1,91:1 são cortadas verticalmente. Para informar o ponto crucial das imagens, apresente as informações mais importantes no centro.
Etapa 2: verificar a resposta da API
Uma resposta bem-sucedida inclui um objeto messages com um id.
{
"messages": [{
"id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
}]
}
Uma resposta malsucedida contém um objeto com uma string de erro, um código correspondente e outras informações.
Se um modelo for encaminhado a uma conta que não pode recebê-lo, o erro 1026 (ReceiverIncapable) será enviado ao servidor de Webhook configurado.
Consulte Mensagens de erro e status para obter mais informações sobre erros.
Exemplos
Estes exemplos mostram o processo de configuração de modelos de mensagem de mídia, desde a criação de um modelo no Gerenciador de Negócios até o envio dele com chamadas de API para o ponto de extremidade messages.
Os exemplos servem apenas para fins ilustrativos e não podem ser usados para outras funções. Você deve criar os próprios exemplos, que precisam ser aprovados para testar a funcionalidade dos modelos de mensagem de mídia.
Exemplo com ingresso de cinema
Este exemplo mostra a criação de um modelo de mensagem de mídia com uma imagem de código QR.
1. Crie o modelo de mensagem de mídia no Gerenciador de Negócios.
2. A chamada de API messages adiciona as informações do parâmetro.
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. O cliente recebe a mensagem com o ingresso de cinema.
Exemplo com cartão de embarque
Este exemplo mostra a criação de um modelo de mensagem de mídia com um documento PDF.
1. Crie o modelo de mensagem de mídia no Gerenciador de Negócios.
2. A chamada de API messages adiciona as informações do parâmetro.
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. O cliente recebe o cartão de embarque em um documento PDF.
