Cadastrar modelos

Para criar um modelo de mensagem de texto, envie uma solicitação POST para o endpoint api/Templates/. Depois, inclua namecategorylanguagecomponents com type definido como BODY e text definido como conteúdo da mensagem para os campos name e language.

    Estes são os valores válidos de `category` para solicitações da versão 5.0:
  • AUTHENTICATION

  • MARKETING

  • UTILITY

    "components": [
    Adicione outra matriz type a components para a mídia que você quer incluir no modelo. Essa matriz incluirá um type definido como BODY e um format definido de acordo com o tipo de mídia (TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION). Além disso, é possível incluir informações opcionais para texto e exemplos.

Exemplo de solicitação de criação

O exemplo abaixo cria um modelo de template:

curl --request POST \
  --url https://api-cerberus-kong.socialminer.tech/api/Templates \
  --header 'Content-Type: application/json' \
  --header 'apikey: YtCfGVU6vOwkGfgfTgaYkikombKzRzwR' \
  --header 'version: 5.0' \
  --data ' {
 	"name": "order_status_reject",
 	"components": [
         {
            "type": "BODY",
            "format": "TEXT",
 			"text": "Desculpe, não poderemos enviar seu pedido: {{1}}",
 			"example": {
                "body_text": [
                     [
                         "Falta de ingredientes"
 					]
 				]
 			}
        }
 	],
 	"language": "pt_BR",
 	"category": "TICKET_UPDATE"
 }'

Exemplo de solicitação de modelo interativo

O exemplo abaixo cria um modelo com um botão que pode ser usado pelos clientes para ligar para o número da empresa e pedir ajuda na resolução de um problema.

TO-DO

Se ela for bem-sucedida, será retornado um objeto JSON com o ID do modelo de mensagem e o http status 201:

{ "id":  "TEMPLATE_ID",  "status":  "TEMPLATE_STATUS",  "category":  "TEMPLATE_CATEGORY"  }

Caso o modelo já exista, o mesmo não sofre alterações e é retornado o http status 200.

Adicionar cabeçalho de localização ao modelo

Também é possível compartilhar informações de localização com os usuários ao adicionar um cabeçalho de localização aos modelos.Esse cabeçalho está disponível tanto para os modelos de serviços quanto para os de marketing. Isso facilitará diversos casos de uso, incluindo: rastreamento de entregas de comida; resumo da solicitação e ponto de partida(serviços de deslocamento); e busca de lojas nas imediações (compras locais). O modelo refletirá uma localização estática definida pela empresa para um caso de uso específico (por exemplo, o local de retirada para um pedido específico de um usuário específico). No momento, o compartilhamento de localização em tempo real não está disponível. [Saiba mais sobre o compartilhamento nativo de localização na Central de Ajuda do facebook] (https://www.facebook.com/business/help/167493502302332).

Exemplo de solicitação

A solicitação POST a seguir demonstra como incorporar o cabeçalho aos modelos de mensagem.

curl -X POST "https://api-cerberus-kong.socialminer.tech/api/Templates
{
	"name": "order_pickup_location_template_message",
	"language": "en_US",
	"category": "MARKETING",
	"components": [{
			"type": "HEADER",
			"format": "LOCATION"
      },
		 {
    "type": "BODY",
			"text": "Order  Update:  {{1}}",
			"example": { "body_text": [["Pickup your order from here!"]]}
      },
		 {
    "type": "FOOTER",
			"text": "Thank  You  for ordering!"

      }]
}

Se ela for bem-sucedida, será retornado um objeto JSON com o ID do modelo de mensagem:

{
    "status": "APPROVED",
	"category": "MARKETING",
	"id": "1870780803297694"
}

Para ver uma lista completa dos parâmetros, acesse a [referência WhatsAppBusinessAccount/message_templates] (https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/#Creating).

Language
Click Try It! to start a request and see the response here!