Conversas

Listar Conversas

Retorna a lista de conversas externas da conta autenticada, com suporte a filtros por setor e responsável.

GET/account-external-conversation
curl --request GET \
  --url 'https://crm.wavups.com/api/v1/account-external-conversation?accountChatSectorId=csector001' \
  --header 'Token: SEU_TOKEN_DE_API'
[
  {
    "id": "clxyz123",
    "leadId": "clead456",
    "accountChatSectorId": "csector001",
    "contactName": "Maria Silva",
    "contactPhone": "+5511999990000",
    "contactUsername": null,
    "lastMessage": { "type": "text", "text": "Olá, tudo bem?" },
    "lastMessageAt": "2025-10-01T14:30:00.000Z",
    "unreadCount": 2,
    "status": "active",
    "state": "NEW",
    "createdAt": "2025-09-15T10:00:00.000Z",
    "AccountCRMLead": {
      "id": "clead456",
      "leadOwner": "cuser789",
      "LeadOwner": {
        "User": {
          "name": "João Souza"
        }
      }
    },
    "PlatformIntegration": {
      "name": "WhatsApp"
    },
    "accountLabelAssignments": [
      {
        "AccountLabel": {
          "id": "clabel001",
          "name": "Urgente",
          "color": "#FF0000"
        }
      }
    ]
  }
]

Requisição

GET https://crm.wavups.com/api/v1/account-external-conversation

Tokenstringobrigatório

Seu token de autenticação.

Query Parameters

Filtra conversas pertencentes a um setor específico. Informe o ID do setor.

leadOwnerstring

Filtra conversas pelo ID do usuário responsável pelo Lead da conversa. Também aceita conversationOwnerId.


Resposta

Retorna um array de objetos de conversa, ordenados do mais recente para o mais antigo. Os campos internos accountId, externalId, externalContactId, platformIntegrationId e updatedAt são omitidos.

idstring

Identificador único da conversa.

leadIdstring | null

ID do lead vinculado à conversa.

accountChatSectorIdstring | null

ID do setor de chat ao qual a conversa pertence.

Nome do contato da conversa.

contactPhonestring | null

Telefone do contato.

contactUsernamestring | null

Username do contato (ex: handle do Instagram ou nome de usuário do WhatsApp).

lastMessageobject | null

Objeto JSON com os dados da última mensagem da conversa.

lastMessageAtstring | null

Data e hora da última mensagem (ISO 8601).

Quantidade de mensagens não lidas. Padrão: 0.

statusstring

Status da conversa. Padrão: active.

statestring | null

Estado atual do atendimento da conversa. Padrão: NEW. Valores possíveis:

  • NEW: conversa recém-criada, ainda não iniciada.
  • AI_ANSWERING: a IA está respondendo automaticamente ao contato.
  • NEEDS_HUMAN: a conversa precisa de atendimento humano.
  • NO_RESPONSE: o contato não respondeu.
  • COMPLETED: o atendimento foi concluído.
  • ARCHIVED: a conversa foi arquivada.
createdAtstring

Data de criação da conversa (ISO 8601).

AccountCRMLeadobject | null

Objeto do Lead vinculado à conversa contendo os dados do responsável (leadOwner).

Dados da integração de plataforma associada à conversa.

Lista de etiquetas atribuídas à conversa.


Autorização

Tokenstring · headerobrigatório

Token de autenticacao gerado na plataforma WavUps CRM.

Parâmetros de consulta

Filtra conversas pertencentes a um setor específico.

leadOwnerstring

Filtra conversas pelo ID do usuário responsável pelo Lead da conversa.

Filtra conversas pelo ID do responsável.

Respostas

200application/json · object[]

Lista de conversas retornada com sucesso.

idstring
contactNamestring | null
contactPhonestring | null
accountChatSectorIdstring | null
conversationOwnerIdstring | null
statusstring
stateenum<string> | null

Valores aceitos: NEW, AI_ANSWERING, NEEDS_HUMAN, NO_RESPONSE, COMPLETED, ARCHIVED

createdAtstring<date-time>
500