Use as notificações para obter diretamente o status das mensagens enviadas.
Elas permitem que você obtenha informações relevantes, como o número de mensagens lidas de suas mensagens individuais, em massa ou de campanha.
Ao usar as notificações, você pode entender o comportamento do usuário e usar essas informações para melhorar sua campanha de marketing ou escolher um tipo de mensagem melhor para ser mais preciso em suas comunicações. Você pode obter informações específicas sobre uma notificação pelo seu ID ou todas as notificações para preencher seu banco de dados ou Dashboard.
Obter Notificações
Este endpoint permite que você recupere notificações enviadas anteriormente.
GET https://api.jelou.ai/v1/external/bots/{botId}/notifications
Parâmetros de Path
| Propriedade | Tipo | Descrição | Obrigatório |
|---|
| botId | string | ID do bot. | Sim |
Parâmetros de Query
| Propriedade | Tipo | Descrição | Obrigatório |
|---|
| messageId | string | ID da mensagem. | Não |
| campaignId | string | ID da campanha. | Não |
| elementName | string | Nome do elemento. | Não |
| from | date | Data de início. | Não |
| to | date | Data de término. | Não |
| limit | number | Limite de paginação (Máx: 50). | Não |
| page | number | Número da página (Padrão: 1). | Não |
Exemplo de Requisição
curl --request GET \
--url 'https://api.jelou.ai/v1/external/bots/BOT_ID/notifications?limit=50&from=2024-01-01&to=2024-12-31&page=1' \
--header 'Authorization: Basic {{Base64EncodedUsername:Password}}'
Lista de status de mensagem
| Status | Descrição |
|---|
DELIVERED_CHANNEL | A mensagem foi recebida pelo WhatsApp. |
DELIVERED_USER | A mensagem foi recebida pelo usuário. |
READ | O usuário leu a mensagem. |
REPLY | O usuário respondeu à mensagem. |
CREATED | A mensagem foi recebida pela Jelou. |
FAILED | A mensagem não pôde ser entregue. |
Status de leitura da mensagem
| Status | Descrição |
|---|
true | O usuário leu a mensagem. |
false | O usuário não leu a mensagem. |
Respostas da API
O payload contém os seguintes campos:
| Propriedade | Descrição |
|---|
| sentStatus | Status de entrega do template. |
| createdAt | Data de envio da mensagem. |
| deliveryChannelAt | Data de entrega ao canal WhatsApp. |
| deliveryUserAt | Data de entrega da mensagem pelo WhatsApp. |
| readAt | Data em que a mensagem foi lida pelo usuário. |
| destination | Número de telefone do usuário. |
| elementName | Nome do template. |
| id | ID da mensagem. |
| error | Motivo da falha na entrega do template (se aplicável). |
| reply | Resposta do usuário (disponível quando o status é REPLY). |
Análise de métricas
Analise as taxas de entrega, leitura e resposta para otimizar futuras campanhas.
- Medir engajamento: Calcule a porcentagem de mensagens lidas em relação às entregues.
- Identificar problemas: Detecte números inválidos ou bloqueados por meio de erros
FAILED.
- Otimizar agendamentos: Analise timestamps para encontrar os melhores horários de envio.
- Melhorar conteúdo: Use respostas (
REPLY) para entender quais mensagens geram mais interação.
