Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

O que essa API faz?

Ela retorna, de maneira estruturada, todos os registros gerados no Evolux Chat, que correspondem à assinantes (contatos) inseridos dentro de uma campanha para disparo automático via Whatsapp.

A quem pode interessar essa API?

Essa API pretende ajudar desenvolvedores, analistas de BI ou qualquer pessoa que precise trabalhar com os dados do Relatório de Campanhas do Evolux Chat para realizar consultas automatizadas, geração de insights, análise visual de dados, entre outras finalidades.

É simples utilizar?

Basicamente você fará uma requisição web, utilizando o método GET, para o endereço https://seuservidor.evolux.cx/api/v1/reports/campaign/subscribers. Para se autenticar, basta passar um Bearer Token no cabeçalho, com a chave de acesso que foi disponibilizada pelo nosso Suporte

Passo a passo:

URL

https://SEUSERVIDOR.evolux.cx

Endpoint

/api/v1/reports/campaign/subscribers

Método

GET

Autenticação

Bearer Token

Parâmetros

chave

Tipo aceito no valor

Descrição

phone_number

string

Número de telefone do assinante (ex: 1199881122)

name

string

Nome do assinante (ex: Maria do Carmo)

state

string

Status daquele disparo. As opções válidas são:

  • pending : Mensagem não foi disparada, está pendente;

  • scheduled : Mensagem está agendada;

  • sent : Mensagem foi enviada, porém ainda não houve interação do cliente;

  • dnd : Assinante foi inserido em uma lista de Não Perturbe;

  • completed : Mensagem foi disparada e o cliente interagiu com ela;

  • error : Erro no disparo, pode ser template da Meta com restrição, pode ser que o contato já tenha uma conversa ativa na plataforma, entre outros.

template_uuid

UUID

UUID do template (solicitar ao Suporte Evolux)
Ex: 70f4ddb6-ece1-4e13-ab90-3698d9d72bf0

campaigns[]

UUID

UUID que fica exposto na url da gestão de uma determinada campanha; (Aceita repetição dessa mesma chave, com o UUID de outras campanhas)
Ex: f45d98dc-ac5e-48f2-9c01-ebe18f86d28b

start

ISO Date

Data de corte inicial para o momento da inserção do assinante na campanha
Ex: 2024-08-03T03%3A00%3A00.000Z

end

ISO Date

Data de corte final para o momento da inserção do assinante na campanha
Ex: 2024-08-04T02%3A59%3A59.999Z

timezone

string

Fuso Horário (padrão é America/Sao_Paulo)

conversation_field_key

string

Nome de algum campo customizado (precisa do valor)

Ex: CPF

conversation_field_value

string

Valor de algum campo customizado (precisa do campo)
Ex: 111.111.111-11

Exemplos de uso:

Caso 1 : Quero ver todos os assinantes que foram inseridos entre o dia 05 e 06 de setembro de 2024, cujo perfil (inserido em um campo customizado da campanha) seja “Pessoa Jurídica”, independente de qual campanha estão participando.

Requisição em cURL:

curl --location 'https://seuservidor.evolux.cx/api/v1/reports/campaign/subscribers?start=2024-09-05T00%3A00%3A00.000Z&end=2024-09-06T23%3A59%3A59.999Z&conversation_field_key=perfil&conversation_field_value=Pessoa%20Jur%C3%ADdica' \
--header 'Authorization: Bearer ********-****-****-****-************'


Requisição em Python:

import requests

url = "https://seuservidor.evolux.cx/api/v1/reports/campaign/subscribers?start=2024-09-05T00%3A00%3A00.000Z&end=2024-09-06T23%3A59%3A59.999Z&conversation_field_key=perfil&conversation_field_value=Pessoa Jurídica"

payload = {}
headers = {
  'Authorization': 'Bearer ********-****-****-****-************'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
  • No labels