# Conversas

> Listar conversas e ler mensagens.

Conversas são os atendimentos de cada contato numa caixa (WhatsApp ou outro canal). Liste com filtros (`estado`, `caixa_id`, `contato_id`, `telefone`, `desde`) e leia as mensagens de cada uma, da mais nova para a mais antiga.

- Notas internas da equipe não aparecem na API.
- Para acompanhar em tempo real, prefira webhooks (`mensagem.recebida`, `conversa.criada`, `conversa.atribuida`, `conversa.encerrada`) a ficar consultando.
- Para atribuir uma conversa a alguém ou a uma equipe, veja [`POST /conversas/{id}/atribuir`](https://docs.forsi.com.br/api/equipe/atribuir-conversa) em Equipe e permissões.

**Códigos de erro comuns aqui**: `conversa_inexistente`, `cursor_invalido` (todos em [Erros](https://docs.forsi.com.br/erros)).

## GET /conversas — Listar conversas

- URL: `GET https://chat.forsi.com.br/api/v1/conversas`
- Acesso: escopo `conversas:ler` · módulo do plano: API
- Sucesso: `200`, `{"dados": ...}` com lista de `Conversa` (paginada por cursor)
- Página: https://docs.forsi.com.br/api/conversas/listar-conversas (Markdown: https://docs.forsi.com.br/api/conversas/listar-conversas.md)

Da mais recente para a mais antiga, paginado por cursor.

**Parâmetros de consulta (query string)**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `estado` | "aberta" \| "pendente" \| "adiada" \| "resolvida" | não |  |
| `caixa_id` | uuid | não |  |
| `contato_id` | uuid | não |  |
| `telefone` | string | não | Com DDI e DDD. Acha o contato com ou sem o 9º dígito. mín. 8 caracteres até 30 caracteres ex.: +55 31 98888-7777 |
| `desde` | data e hora ISO 8601 | não | Só conversas atualizadas a partir desta data (ISO 8601). |
| `anuncio` | string | não | Só conversas que vieram de anúncio: `1` para qualquer anúncio ou o id de um anúncio. |
| `limite` | integer | não | Itens por página (1 a 100, padrão 50). |
| `cursor` | string | não | Valor de `proximo` da página anterior. até 80 caracteres |

**Exemplo (curl)**

```bash
curl "https://chat.forsi.com.br/api/v1/conversas?estado=aberta&limite=20" \
  -H "Authorization: Bearer $FORSI_CHAVE"
```

**Resposta `200` (exemplo)**

```json
{
  "dados": [
    {
      "id": "495a7cae-128c-4b66-adbc-807b3959c129",
      "caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445",
      "grupo": false,
      "titulo": "Consulta de retorno",
      "estado": "aberta",
      "responsavel_id": "42b8028f-d7ce-4706-9567-44ac3bff4219",
      "equipe_id": "55174f08-dda3-49e6-bc5d-9309becdaf6d",
      "agente_id": "d1ab0f6b-41bf-4522-baaa-c3e281a79935",
      "etiquetas": ["ea287b0d-9968-4022-b9c7-b6dc239e6101"],
      "nao_lidas": 2,
      "janela_ate": "2026-10-04T13:05:12.481Z",
      "ultima_mensagem_em": "2026-10-04T13:05:12.481Z",
      "ultima_previa": "Oi, queria remarcar minha consulta",
      "ultima_direcao": "texto",
      "criado_em": "2026-10-04T13:05:12.481Z",
      "atualizado_em": "2026-10-04T13:05:12.481Z",
      "resolvida_em": "2026-10-04T13:05:12.481Z",
      "contato": {
        "id": "08054a7f-a752-481e-9915-cf4cf944df39",
        "nome": "Maria Souza",
        "telefone": "+5531988887777"
      },
      "origem_anuncio": {
        "anuncio_id": "texto",
        "titulo": "Consulta de retorno",
        "canal": "whatsapp",
        "clicado_em": "2026-10-04T13:05:12.481Z"
      }
    }
  ],
  "proximo": "1791205512481_3791c08d-72dd-4002-89ff-1e14a11c07e5"
}
```

**Erros**: `401`, `403`, `422`, `429` (formato e códigos em "Erros"; códigos desta seção no início dela).

## GET /conversas/{id} — Ver uma conversa

- URL: `GET https://chat.forsi.com.br/api/v1/conversas/{id}`
- Acesso: escopo `conversas:ler` · módulo do plano: API
- Sucesso: `200`, `{"dados": ...}` com `Conversa`
- Página: https://docs.forsi.com.br/api/conversas/ver-conversa (Markdown: https://docs.forsi.com.br/api/conversas/ver-conversa.md)

**Parâmetros no caminho**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | sim | No caminho da URL. |

**Exemplo (curl)**

```bash
curl "https://chat.forsi.com.br/api/v1/conversas/495a7cae-128c-4b66-adbc-807b3959c129" \
  -H "Authorization: Bearer $FORSI_CHAVE"
```

**Resposta `200` (exemplo)**

```json
{
  "dados": {
    "id": "495a7cae-128c-4b66-adbc-807b3959c129",
    "caixa_id": "7a9d53e9-9d1b-4122-923b-fac67958f445",
    "grupo": false,
    "titulo": "Consulta de retorno",
    "estado": "aberta",
    "responsavel_id": "42b8028f-d7ce-4706-9567-44ac3bff4219",
    "equipe_id": "55174f08-dda3-49e6-bc5d-9309becdaf6d",
    "agente_id": "d1ab0f6b-41bf-4522-baaa-c3e281a79935",
    "etiquetas": ["ea287b0d-9968-4022-b9c7-b6dc239e6101"],
    "nao_lidas": 2,
    "janela_ate": "2026-10-04T13:05:12.481Z",
    "ultima_mensagem_em": "2026-10-04T13:05:12.481Z",
    "ultima_previa": "Oi, queria remarcar minha consulta",
    "ultima_direcao": "texto",
    "criado_em": "2026-10-04T13:05:12.481Z",
    "atualizado_em": "2026-10-04T13:05:12.481Z",
    "resolvida_em": "2026-10-04T13:05:12.481Z",
    "contato": {
      "id": "08054a7f-a752-481e-9915-cf4cf944df39",
      "nome": "Maria Souza",
      "telefone": "+5531988887777"
    },
    "origem_anuncio": {
      "anuncio_id": "texto",
      "titulo": "Consulta de retorno",
      "canal": "whatsapp",
      "clicado_em": "2026-10-04T13:05:12.481Z"
    }
  }
}
```

**Erros**: `401`, `403`, `404`, `422`, `429` (formato e códigos em "Erros"; códigos desta seção no início dela).

## GET /conversas/{id}/mensagens — Mensagens de uma conversa

- URL: `GET https://chat.forsi.com.br/api/v1/conversas/{id}/mensagens`
- Acesso: escopo `mensagens:ler` · módulo do plano: API
- Sucesso: `200`, `{"dados": ...}` com lista de `Mensagem` (paginada por cursor)
- Página: https://docs.forsi.com.br/api/conversas/listar-mensagens (Markdown: https://docs.forsi.com.br/api/conversas/listar-mensagens.md)

Da mais nova para a mais antiga. Notas internas da equipe não aparecem.

**Parâmetros no caminho**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | sim | No caminho da URL. |

**Parâmetros de consulta (query string)**

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `limite` | integer | não | Itens por página (1 a 100, padrão 50). |
| `cursor` | string | não | Valor de `proximo` da página anterior. até 80 caracteres |

**Exemplo (curl)**

```bash
curl "https://chat.forsi.com.br/api/v1/conversas/495a7cae-128c-4b66-adbc-807b3959c129/mensagens?limite=50" \
  -H "Authorization: Bearer $FORSI_CHAVE"
```

**Resposta `200` (exemplo)**

```json
{
  "dados": [
    {
      "id": "4e8cb5d0-2d89-4fc2-93bb-c8e5e17d4629",
      "conversa_id": "495a7cae-128c-4b66-adbc-807b3959c129",
      "direcao": "entrada",
      "tipo": "texto",
      "texto": "Oi, queria remarcar minha consulta",
      "estado": "pendente",
      "erro": "Connection timed out",
      "autor_tipo": "contato",
      "responde_a_id": "ad52f13b-411d-4526-9d07-91f222c74891",
      "id_whatsapp": "wamid.HBgNNTUzMTk4ODg4Nzc3NxUCABEYEjQ",
      "enviada_em": "2026-10-04T13:05:12.481Z",
      "criado_em": "2026-10-04T13:05:12.481Z",
      "editada_em": "2026-10-04T13:05:12.481Z",
      "apagada_em": "2026-10-04T13:05:12.481Z",
      "pela_api": {"chave_id":"71c5c606-a9d7-4270-8891-45d783aa9b71"},
      "modelo": "texto",
      "midia": [
        {
          "id": "94ac725d-5a70-40b2-8fa6-cdd23a32ac85",
          "mime": "image/jpeg",
          "nome_arquivo": "foto.jpg",
          "tamanho": 48213,
          "duracao_s": 1.5
        }
      ]
    }
  ],
  "proximo": "1791205512481_3791c08d-72dd-4002-89ff-1e14a11c07e5"
}
```

**Erros**: `401`, `403`, `404`, `422`, `429` (formato e códigos em "Erros"; códigos desta seção no início dela).

## Objetos das respostas

Campos de cada objeto devolvido em `dados`. Campos novos podem aparecer: ignore os que não conhecer.

### Conversa

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | não |  |
| `caixa_id` | uuid | não |  |
| `grupo` | boolean | não |  |
| `titulo` | string ou null | não |  |
| `estado` | "aberta" \| "pendente" \| "adiada" \| "resolvida" | não |  |
| `responsavel_id` | uuid ou null | não |  |
| `equipe_id` | uuid ou null | não |  |
| `agente_id` | uuid ou null | não |  |
| `etiquetas` | lista de uuid | não |  |
| `nao_lidas` | integer | não |  |
| `janela_ate` | data e hora ISO 8601 ou null | não | Até quando a janela de 24 h da API oficial está aberta. |
| `ultima_mensagem_em` | data e hora ISO 8601 ou null | não |  |
| `ultima_previa` | string ou null | não |  |
| `ultima_direcao` | string ou null | não |  |
| `criado_em` | data e hora ISO 8601 | não |  |
| `atualizado_em` | data e hora ISO 8601 | não |  |
| `resolvida_em` | data e hora ISO 8601 ou null | não |  |
| `contato` | object ou null | não |  |
| `contato.id` | uuid | não |  |
| `contato.nome` | string ou null | não |  |
| `contato.telefone` | string ou null | não |  |
| `origem_anuncio` | object ou null | não | Primeiro anúncio que levou a pessoa ao WhatsApp, Instagram ou Messenger. |
| `origem_anuncio.anuncio_id` | string ou null | não |  |
| `origem_anuncio.titulo` | string ou null | não |  |
| `origem_anuncio.canal` | string | não |  |
| `origem_anuncio.clicado_em` | data e hora ISO 8601 | não |  |

### Mensagem

| Campo | Tipo | Obrigatório | Notas |
| --- | --- | --- | --- |
| `id` | uuid | não |  |
| `conversa_id` | uuid | não |  |
| `direcao` | "entrada" \| "saida" | não |  |
| `tipo` | string | não | ex.: texto |
| `texto` | string | não |  |
| `estado` | "pendente" \| "enviando" \| "enviada" \| "entregue" \| "lida" \| "tocada" \| "falhou" \| "recebida" \| "nao_confirmado" | não | nao_confirmado: a conexão caiu durante o envio e o WhatsApp não confirmou; a mensagem pode ter chegado. Não é reenviada sozinha. |
| `erro` | string | não |  |
| `autor_tipo` | "contato" \| "usuario" \| "agente" \| "sistema" \| "celular" | não |  |
| `responde_a_id` | uuid | não |  |
| `id_whatsapp` | string | não |  |
| `enviada_em` | data e hora ISO 8601 | não |  |
| `criado_em` | data e hora ISO 8601 | não |  |
| `editada_em` | data e hora ISO 8601 | não |  |
| `apagada_em` | data e hora ISO 8601 | não |  |
| `pela_api` | object | não |  |
| `pela_api.chave_id` | uuid | não |  |
| `modelo` | string | não | Nome do modelo, quando tipo = modelo. |
| `midia` | lista de object | não |  |
| `midia[].id` | uuid | não |  |
| `midia[].mime` | string | não |  |
| `midia[].nome_arquivo` | string | não |  |
| `midia[].tamanho` | integer | não |  |
| `midia[].duracao_s` | number | não |  |

---

Página: https://docs.forsi.com.br/api/conversas · Índice: https://docs.forsi.com.br/llms.txt · Tudo num arquivo: https://docs.forsi.com.br/llms-full.txt