Templates (HSM)

Templates são obrigatórios para iniciar conversas fora da janela de 24 horas.

Todas as requisições devem ser feitas utilizando autenticação Bearer Token.

Envios de templates

URL Base de envio de template:

POST https://sync-core-api.otima.io/whatsapp/provider/{NUMERO_AQUI}/send-message

---

Categorias templates

• marketing

• utility

• authentication

Tipos

• marketing_lite -- apenas templates marketing

• cloud_api

---

Recursos Disponíveis

• Variáveis dinâmicas do template

• Header com imagem, vídeo ou documento

• Botões URL

• Botões de resposta rápida

• Parâmetros personalizados

---

Estrutura para o Envio (payload)

{
  "messaging_product": "whatsapp",
  "to": "5511999999999",
  "type": "template",
  "template": {
    "name": "confirmacao_pedido",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          { "type": "text", "text": "Marcio" },
          { "type": "text", "text": "12345" }
        ]
      }
    ]
  }
}

Listar Templates (GET)

Lista os templates do workspace autenticado ou por business_manager(BM)

GET https://sync-core-api.otima.io/whatsapp/provider/workspace-templates?business_id=10101010101000

Parâmetros de rota

Parâmetro	Tipo	Descrição
business_id	string	ID do Business Manager(BM)

Modelos de envios (POST)

Envia templates do workspace com HEADER (imagens, documentos e videos)

POST https://sync-core-api.otima.io/whatsapp/provider/{NUMERO_AQUI}/send-message

Imagem:

{
  "messaging_product": "whatsapp",
  "to": "554399999999",
  "type": "template",
  "template": {
    "name": "template_header_image",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "image",
            "image": {
              "link": "https://site.com/imagem.jpg"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Jorge"
          }
        ]
      }
    ]
  }
}

Documento (PDF/XLS/DOC..):

{
  "messaging_product": "whatsapp",
  "to": "554399999999",
  "type": "template",
  "template": {
    "name": "template_header_document",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "document",
            "document": {
              "link": "https://site.com/contrato.pdf",
              "filename": "contrato.pdf"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Carlos"
          }
        ]
      }
    ]
  }
}

Video:

{
  "messaging_product": "whatsapp",
  "to": "5543999999999",
  "type": "template",
  "template": {
    "name": "template_header_video",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "header",
        "parameters": [
          {
            "type": "video",
            "video": {
              "link": "https://site.com/video.mp4"
            }
          }
        ]
      },
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Luis"
          }
        ]
      }
    ]
  }
}

Modelos template FOOTER:

{
  "messaging_product": "whatsapp",
  "to": "554399999999",
  "type": "template",
  "template": {
    "name": "template_footer",
    "language": {
      "code": "pt_BR"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "Bruna"
          }
        ]
      },
      {
        "type": "footer",
        "parameters": [
          {
            "type": "text",
            "text": "Equipe Financeiro"
          }
        ]
      }
    ]
  }
}