Base URL

https://lip-backend-1064145932505.southamerica-east1.run.app

Endpoints

GET /api/external/conversations
GET /api/external/conversations/{id}
GET /api/external/conversations/{id}/messages

Escopos:

conversations:read — listar e obter conversas
conversations:messages:read — ler mensagens de uma conversa

Todas as rotas sao sincronas e respondem 200 com os dados no corpo. Os resultados sao sempre limitados ao workspace dono da API key.

Listar conversas

GETBuscar/api/external/conversations

Busca a lista paginada de conversas do workspace. Operacao de leitura — nao altera nada.

Escopo: conversations:readSincrono — responde 200 com os dados

Query params

pagenumberopcionaldefault: 1

Numero da pagina.

limitnumberopcionaldefault: 20

Itens por pagina (max 100).

statusstringopcional

BOT, HUMAN, CLOSED ou QUEUED.

prioritystringopcional

low, medium ou high.

tagsstringopcional

Lista separada por virgula (ex: vip,suporte).

chatTypestringopcional

INDIVIDUAL ou GROUP.

searchstringopcional

Busca por termo (nome, telefone, conteudo).

assignedWorkspaceMemberstringopcional

Id do membro responsavel.

Regras de selecao:

Com search, a busca textual e aplicada com os demais filtros.
Sem search, mas com status, lista conversas naquele status.
Sem search e sem status, lista as conversas ativas.

Exemplo:

Resposta:

Obter conversa

GETBuscar/api/external/conversations/{id}

Busca uma unica conversa pelo id, no mesmo formato dos itens da listagem.

Escopo: conversations:readSincrono — responde 200 com os dados

Exemplo:

Erros:

404 quando a conversa nao existe no workspace.

Listar mensagens da conversa

GETBuscar/api/external/conversations/{id}/messages

Busca o historico paginado de mensagens de uma conversa.

Escopo: conversations:messages:readSincrono — responde 200 com os dados

Query params

pagenumberopcionaldefault: 1

Numero da pagina.

limitnumberopcionaldefault: 50

Itens por pagina (max 100).

sortOrderstringopcionaldefault: desc

asc ou desc. Com desc, as mensagens mais recentes vem primeiro.

Exemplo:

Resposta:

Erros:

404 quando a conversa nao existe no workspace.

Valores de referencia

messageType:

TEXT, IMAGE, VIDEO, AUDIO, DOCUMENT, LOCATION, STICKER, CONTACT, TEMPLATE, INTERACTIVE, REACTION, ORDER, SYSTEM, BUTTON

status da mensagem:

RECEIVED, SENT, DELIVERED, READ, FAILED

messageOrigin:

client (cliente final), WorkspaceMember (atendente), bot, system

status da conversa:

BOT, HUMAN, CLOSED, QUEUED

URLs de midia

mediaUrl e temporaria

Quando a mensagem tem midia, mediaUrl e retornada assinada e temporaria (expira apos o TTL padrao de armazenamento). Baixe o arquivo logo apos a leitura e nao armazene a URL assinada por longos periodos — refaca a consulta para obter uma nova quando precisar.