Introdução a API Connect

APIs
(Interface de Programação de Aplicações)

API é uma forma de facilitar a comunicação entre diferentes sistemas, permitindo que eles compartilhem informações de forma rápida e eficiente.
✅ Nossa plataforma oferece diversas APIs que permitem integração com outras aplicações, possibilitando o envio de mensagens, início de fluxos, atualização de tags, consulta de status, gerenciamento de leads e muito mais.


Retornos de API


Payloads de Resposta

📌 CONTATO

Id do Contato (lead)
Mensagem de Texto (ticket.contact.id)

Nome do Contato (lead)
Mensagem de Texto (ticket.contact.name)

WhatsApp do Contato (lead)
Mensagem de Texto (ticket.contact.number)

Email do Contato (lead)
Mensagem de Texto (ticket.contact.email)

📌 TICKET

Id do Ticket
Mensagem de Texto (ticket.id)

Status do Ticket
Mensagem de Texto (ticket.status)

Protocolo do Ticket
Mensagem de Texto (ticket.protocolo)

Última Mensagem do Ticket
Mensagem de Texto (ticket.lastMessage)

Id do Atendente do Ticket
Mensagem de Texto (ticket.user.id)

Nome do Atendente do Ticket
Mensagem de Texto (ticket.user.name)


📌 WhatsApp do Atendente do Ticket
Mensagem de Texto (ticket.user.number)


📌 TAG

Id do Tag
Mensagem de Texto (ticket.tags.id)

Nome da Tag
Mensagem de Texto (ticket.tags.name)

📌 FILA

Id da Fila
Mensagem de Texto (ticket.queue.id)

Nome da Fila
Mensagem de Texto (ticket.queue.name)

📌 CONEXÃO

Id da Conexão
Mensagem de Texto (ticket.whatsapp.id)
Status das Conexões (id)

Nome da Conexão
Mensagem de Texto (ticket.whatsapp.name)
Status das Conexões (name)

Status da Conexão
Mensagem de Texto (ticket.whatsapp.status)
Status das Conexões (status)

Token da Conexão
Mensagem de Texto (ticket.whatsapp.token)
Status das Conexões (token)

Url Webhook da Conexão
Mensagem de Texto (ticket.whatsapp.webhook)
Status das Conexões (webhook)

Número WhatsApp da Conexão
Status das Conexões (number)

Canal da Conexão
Mensagem de Texto (ticket.whatsapp.channel)
Status das Conexões (channel)

Filas da Conexão
Status das Conexões (queues [array])


📌 EMPRESA

Id da Empresa
Mensagem de Texto (ticket.companyId)
Status das Conexões (company.id)

Nome da Empresa
Mensagem de Texto (ticket.company.name)
Status das Conexões (company.name)


Atualizado em 22/04/2025
Este artigo foi útil?  
Agradecemos sua avaliação.