Conversations

Conversas e mensagens

GET`/api/conversation-stages`

Etapas comerciais do time

Escopo exigido: conversations.read

bash

curl "https://api.zapyflow.com.br/api/conversation-stages" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

POST`/api/conversation-stages`

Criar etapa comercial

Escopo exigido: conversation_stages.write

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	sim	min 1, max 40
`color`	`string`	sim	—

bash

curl -X POST "https://api.zapyflow.com.br/api/conversation-stages" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
409 — Conflito com o estado atual
422 — Entendido, mas recusado por uma regra

PATCH`/api/conversation-stages/{id}`

Renomear ou repintar uma etapa comercial

Escopo exigido: conversation_stages.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	não	min 1, max 40
`color`	`string`	não	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/conversation-stages/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
409 — Conflito com o estado atual

DELETE`/api/conversation-stages/{id}`

Excluir etapa comercial

Escopo exigido: conversation_stages.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/conversation-stages/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
409 — Conflito com o estado atual

GET`/api/conversations`

Listar conversas do time com filtros

Escopo exigido: conversations.read

Parâmetro	Onde	Obrigatório
`page`	query	não
`limit`	query	não
`status`	query	não
`handoffType`	query	não
`aiAgentId`	query	não
`search`	query	não
`assignee`	query	não

bash

curl "https://api.zapyflow.com.br/api/conversations" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

GET`/api/conversations/{id}`

Detalhes de uma conversa

Escopo exigido: conversations.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/conversations/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

PATCH`/api/conversations/{id}`

Atualizar status ou assignedTo de uma conversa

Escopo exigido: conversations.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`status`	`"ACTIVE" \| "RESOLVED" \| "HANDED_OFF"`	não	—
`handoffType`	`string`	não	—
`assignedTo`	`string`	não	—
`assignedToUserId`	`stringnull`	não	—

bash

curl -X PATCH "https://api.zapyflow.com.br/api/conversations/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
422 — Entendido, mas recusado por uma regra

POST`/api/conversations/{id}/ai-insights`

Gerar insights IA sobre uma conversa

Escopo exigido: conversations.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/conversations/{id}/ai-insights" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

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

Listar mensagens de uma conversa com paginacao para historico antigo

Escopo exigido: conversations.read

Parâmetro	Onde	Obrigatório
`limit`	query	não
`cursor`	query	não
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/conversations/{id}/messages" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
400 — Requisição malformada
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/conversations/{id}/messages`

Enviar mensagem como agente humano na conversa

Escopo exigido: conversations.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`content`	`string`	não	min 1
`type`	`"TEXT" \| "AUDIO" \| "IMAGE" \| "VIDEO" \| "DOCUMENT" \| "LOCATION"`	não	—
`mediaUrl`	`string`	não	—
`template`	`object`	não	—
`replyToMessageId`	`string`	não	—
`idempotencyKey`	`string`	não	min 8, max 160
`correlationId`	`string`	não	min 8, max 160

bash

curl -X POST "https://api.zapyflow.com.br/api/conversations/{id}/messages" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
400 — Requisição malformada
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace
409 — Conflito com o estado atual
503

POST`/api/conversations/{id}/messages/{messageId}/react`

Reagir a uma mensagem com emoji

Escopo exigido: conversations.write

Parâmetro	Onde	Obrigatório
`id`	path	sim
`messageId`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`emoji`	`string`	sim	max 16

bash

curl -X POST "https://api.zapyflow.com.br/api/conversations/{id}/messages/{messageId}/react" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
400 — Requisição malformada
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET`/api/conversations/{id}/template-availability`

Disponibilidade de janela e cotas por categoria de modelo

Escopo exigido: conversations.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/conversations/{id}/template-availability" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/conversations/{id}/upload-media`

Upload de mídia (anexo/áudio) para enviar numa conversa

Escopo exigido: conversations.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/conversations/{id}/upload-media" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
400 — Requisição malformada
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

GET`/api/conversations/{id}/utility-check`

Disponibilidade de janela e cotas por categoria de modelo

Escopo exigido: conversations.read

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl "https://api.zapyflow.com.br/api/conversations/{id}/utility-check" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/conversations/new`

Iniciar nova conversa com um numero

Escopo exigido: conversations.write

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`content`	`string`	não	min 1
`type`	`"TEXT" \| "AUDIO" \| "IMAGE" \| "VIDEO" \| "DOCUMENT" \| "LOCATION"`	não	—
`mediaUrl`	`string`	não	—
`template`	`object`	não	—
`replyToMessageId`	`string`	não	—
`idempotencyKey`	`string`	não	min 8, max 160
`correlationId`	`string`	não	min 8, max 160
`channelId`	`string`	sim	—
`phoneNumber`	`string`	sim	min 10, max 40

bash

curl -X POST "https://api.zapyflow.com.br/api/conversations/new" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
400 — Requisição malformada
403 — Proibido, ou a chave não tem este escopo
409 — Conflito com o estado atual
503

GET`/api/conversations/overview`

Métricas de conversas (7 dias) com sparkline e crescimento

Escopo exigido: conversations.read

bash

curl "https://api.zapyflow.com.br/api/conversations/overview" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

GET`/api/media-library`

Arquivos reutilizáveis do time

Escopo exigido: library.read

bash

curl "https://api.zapyflow.com.br/api/media-library" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

POST`/api/media-library`

Guardar um arquivo na biblioteca

Escopo exigido: library.write

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`id`	`string`	sim	—
`name`	`string`	sim	—
`url`	`string`	sim	—
`contentType`	`string`	sim	—
`kind`	`"IMAGE" \| "VIDEO" \| "AUDIO" \| "DOCUMENT"`	sim	—
`sizeBytes`	`integer`	sim	—
`usageCount`	`integer`	sim	—

bash

curl -X POST "https://api.zapyflow.com.br/api/media-library" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
400 — Requisição malformada
409 — Conflito com o estado atual

PATCH`/api/media-library/{id}`

Renomear um arquivo da biblioteca

Escopo exigido: library.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`name`	`string`	sim	min 1, max 120

bash

curl -X PATCH "https://api.zapyflow.com.br/api/media-library/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

DELETE`/api/media-library/{id}`

Tirar um arquivo da biblioteca

Escopo exigido: library.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/media-library/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/media-library/{id}/used`

Registrar envio de um arquivo da biblioteca

Escopo exigido: library.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/media-library/{id}/used" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

GET`/api/quick-replies`

Respostas rápidas do time

Escopo exigido: library.read

bash

curl "https://api.zapyflow.com.br/api/quick-replies" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

POST`/api/quick-replies`

Criar resposta rápida

Escopo exigido: library.write

Corpo da requisição

Campo	Tipo	Obrigatório	Restrições
`shortcut`	`string`	sim	min 1, max 40
`content`	`string`	sim	min 1, max 4000

bash

curl -X POST "https://api.zapyflow.com.br/api/quick-replies" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Respostas

201 — Criado
409 — Conflito com o estado atual

DELETE`/api/quick-replies/{id}`

Excluir resposta rápida

Escopo exigido: library.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X DELETE "https://api.zapyflow.com.br/api/quick-replies/{id}" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK
404 — Não encontrado — também é a resposta quando o recurso é de outro workspace

POST`/api/quick-replies/{id}/used`

Registrar uso de uma resposta rápida

Escopo exigido: library.write

Parâmetro	Onde	Obrigatório
`id`	path	sim

bash

curl -X POST "https://api.zapyflow.com.br/api/quick-replies/{id}/used" \
  -H "Authorization: Bearer $ZAPYFLOW_API_KEY"

Respostas

200 — OK

Conversations

GET/api/conversation-stages

POST/api/conversation-stages

PATCH/api/conversation-stages/{id}

DELETE/api/conversation-stages/{id}

GET/api/conversations

GET/api/conversations/{id}

PATCH/api/conversations/{id}

POST/api/conversations/{id}/ai-insights

GET/api/conversations/{id}/messages

POST/api/conversations/{id}/messages

POST/api/conversations/{id}/messages/{messageId}/react

GET/api/conversations/{id}/template-availability

POST/api/conversations/{id}/upload-media

GET/api/conversations/{id}/utility-check

POST/api/conversations/new

GET/api/conversations/overview

GET/api/media-library

POST/api/media-library

PATCH/api/media-library/{id}

DELETE/api/media-library/{id}

POST/api/media-library/{id}/used

GET/api/quick-replies

POST/api/quick-replies

DELETE/api/quick-replies/{id}

POST/api/quick-replies/{id}/used

GET`/api/conversation-stages`

POST`/api/conversation-stages`

PATCH`/api/conversation-stages/{id}`

DELETE`/api/conversation-stages/{id}`

GET`/api/conversations`

GET`/api/conversations/{id}`

PATCH`/api/conversations/{id}`

POST`/api/conversations/{id}/ai-insights`

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

POST`/api/conversations/{id}/messages`

POST`/api/conversations/{id}/messages/{messageId}/react`

GET`/api/conversations/{id}/template-availability`

POST`/api/conversations/{id}/upload-media`

GET`/api/conversations/{id}/utility-check`

POST`/api/conversations/new`

GET`/api/conversations/overview`

GET`/api/media-library`

POST`/api/media-library`

PATCH`/api/media-library/{id}`

DELETE`/api/media-library/{id}`

POST`/api/media-library/{id}/used`

GET`/api/quick-replies`

POST`/api/quick-replies`

DELETE`/api/quick-replies/{id}`

POST`/api/quick-replies/{id}/used`