Usando a API para consultar templates de WhatsApp

Para consultar templates de WhatsApp usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

Cumprindo esse requisito, siga os passos descritos abaixo:

1. Listar todos os templates

Este endpoint retorna todos os templates de WhatsApp cadastrados no sistema.

Exemplo de chamada:

GET

/api/v1/chat_outbound_templates

Params

Authorization

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/chat_outbound_templates',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

Exemplo de resposta:


{
  "data": [
    {
      "id": 1,
      "type": "chat_outbound_templates",
      "attributes": {
        "name": "template_exemplo",
        "category": "MARKETING",
        "status": "approved",
        "is_configured": true
      }
    },
    {
      "id": 2,
      "type": "chat_outbound_templates",
      "attributes": {
        "name": "template_utilidade",
        "category": "UTILITY",
        "status": "approved",
        "is_configured": true
      }
    }
  ]
}

A resposta inclui um array com todos os templates cadastrados e suas informações.

2. Consultar um template específico

Este endpoint retorna informações detalhadas de um template específico usando seu ID.

Exemplo de chamada:

GET

/api/v1/chat_outbound_templates/1

Params

Authorization

	Key	Value

var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://exemplo.callix.com.br/api/v1/chat_outbound_templates/1',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer {seu_token
  }'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

Para testar, configure na página de Autenticação.

Exemplo de resposta:


{
  "data": {
    "id": 1,
    "type": "chat_outbound_templates",
    "attributes": {
      "name": "template_exemplo",
      "category": "MARKETING",
      "status": "approved",
      "is_configured": true
    }
  }
}

Atributos

Atributo	Tipo	Descrição
`name`	string	Nome do template
`category`	enum	Categoria do template (veja tabela abaixo)
`status`	enum	Status do template (veja tabela abaixo)
`is_configured`	boolean	Define se o template está configurado

Valores possíveis para `category`:

Valor	Descrição
`UTILITY`	Utilidade
`MARKETING`	Marketing
`AUTHENTICATION`	Autenticação

Valores possíveis para `status`:

Valor	Descrição
`in_analysis`	Em análise
`approved`	Aprovado
`disapproved`	Reprovado
`in_appeal`	Em apelação
`pending_deletion`	Exclusão pendente
`deleted`	Excluído no provedor
`disabled`	Inativo
`paused`	Pausado
`limit_exceeded`	Limite excedido
`error`	Erro

Apenas templates com status approved (aprovado) podem ser utilizados para envio de mensagens.

Usando a API para consultar templates de WhatsApp

1. Listar todos os templates

Exemplo de chamada:

Exemplo de resposta:

2. Consultar um template específico

Exemplo de chamada:

Exemplo de resposta:

Atributos

Valores possíveis para category:

Valores possíveis para status:

Valores possíveis para `category`:

Valores possíveis para `status`: