Obter Template

Este endpoint permite obter um template específico para um canal determinado, utilizando o ID do canal e o ID do template.

A resposta inclui detalhes sobre o template, como nome, categoria, status e componentes.

URL Base

A URL base padrão é https://api.pg.iappbr.com.br/api/v1/, seguida pelo endpoint específico.

Endpoint

GET /channel/{channel_id}/template/{template_id}

Parâmetros

Path Parameters

• channel_id (string): ID do canal do qual o template deve ser obtido.

• template_id (string): ID do template que deve ser recuperado.

Obtendo os IDs Necessários

Obter o ID do Canal (channel_id)

1. Acesse a seção "Meus Números" na plataforma.

2. Selecione o canal específico para o qual deseja obter o template.

3. Na barra de endereço do navegador, copie o ID do canal após /channels/{channel_id}.

Obter o ID do Template (template_id)

1. Certifique-se de que você tenha um template criado.

2. Na página do canal selecionado, vá para a seção "templates".

3. Ao lado do nome do template desejado, clique no botão de cópia para copiar o ID do template.

Headers

• Authorization (string): Token de autorização Bearer. Exemplo: Bearer SEU_TOKEN_AQUI

Fazendo a Requisição

Requisição na API

curl --request GET \
  --url 'https://api.pg.iappbr.com.br/api/v1/channel/{channel_id}/template/{template_id}' \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/json'

Substitua {channel_id} e {template_id} pelos IDs obtidos anteriormente.

Exemplo de Resposta

Sucesso (200 OK)

{
  "status": "success",
  "data": {
    "id": "MQ6lrI1dGXDYcRLru3RHWT",
    "name": "iapp_teste_api",
    "category": "MARKETING",
    "status": "approved",
    "language": "pt_BR",
    "components": [
      {
        "type": "HEADER",
        "text": "Isso é uma mensagem de teste para integração. Variável {{1}}!"
      },
      {
        "type": "BODY",
        "text": "Isso é uma mensagem de teste para integração. Teste variável: {{1}}!"
      },
      {
        "type": "FOOTER",
        "text": "Abaixo os botões de teste"
      },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "QUICK_REPLY",
            "text": "Teste Click Reply"
          },
          {
            "type": "COPY_CODE",
            "text": "Copiar código da oferta"
          },
          {
            "type": "URL",
            "text": "Nosso site",
            "url": "https://app.iappbr.com.br/?ref={{1}}"
          },
          {
            "type": "PHONE_NUMBER",
            "text": "Ligar Teste",
            "phone_number": "[phone]"
          }
        ]
      }
    ],
    "rejected_reason": "NONE"
  }
}

Erro (404 Not Found)

{
  "status": "error",
  "message": "Template não encontrado!"
}

---

Campos do Template

Campo	Tipo	Descrição
id	string	Identificador único do template.
name	string	Nome do template.
category	string	Categoria do template "MARKETING" | "UTILITY" | "AUTHENTICATION"
status	string	Status do template "submitted" | "pending" | "approved" | "rejected" | "paused" | "pending_deletion"
language	string	Idioma do template (ex: "pt_BR").
components	array	Array de componentes do template.
components[].type	string	Tipo do componente "HEADER" | "BODY", "FOOTER" | "BUTTONS"
components[].text	string	Texto do componente (para HEADER, BODY, FOOTER).
components[].buttons	array	Array de botões (apenas para tipo BUTTONS).
components[].buttons[].type	string	Tipo do botão "QUICK_REPLY" | "COPY_CODE" | "URL" | "PHONE_NUMBER"
components[].buttons[].text	string	Texto do botão.
components[].buttons[].url	string	URL para botões do tipo URL.
components[].buttons[].phone_number	string	Número de telefone para botões do tipo PHONE_NUMBER.
rejected_reason	string	Razão da rejeição, se aplicável.

---

Notas Adicionais

• Certifique-se de substituir SEU_TOKEN_AQUI pelo seu token de autenticação válido.

• O template retornado inclui informações detalhadas sobre seus componentes, incluindo cabeçalho, corpo, rodapé e botões.

• Os placeholders para variáveis são representados como {{1}}, {{2}}, etc., e devem ser substituídos com os valores reais ao enviar uma mensagem usando este template.

• Copy Code e {{1}} no URL também devem ser substituídos com os valores reais ao enviar uma mensagem usando este template.

• Lembre-se que apenas teplates com status approved podem ser utilizados.