Pular para o conteúdo
Conversas

Listar conversas

v1.0.0
GEThttps://api.growthaisystem.com/api/v1/conversations
  • ExigeAuthorization: Bearer gos_…— Chave de API (gos_…)· escoposconversations.read

Uma linha por CONVERSA (um contato com WhatsApp e Instagram tem duas), cada uma no mesmo formato de GET /conversations/{id} — com ai.paused e a janela de 24h.

Filtros: status (open, o padrão, deixa as arquivadas de fora), connectionId (um número/conta conectado), contactId e updatedAfter (ISO, exclusivo). updatedAt muda a cada mensagem e a cada mudança da conversa (atribuição, arquivamento): para varrer só o que mexeu desde a última leitura, guarde o updatedAt mais recente e mande-o em updatedAfter.

Contato na Lixeira não tem conversa por aqui: contactId de um excluído devolve a lista vazia (a Lixeira fica fora da API).

Paginado por cursor; limit até 100 (padrão 50). Para reagir a mensagem nova em tempo real, prefira o evento message.received a consultar esta lista em laço.

Parâmetros de consulta

Vão na querystring, depois do ?.

  • statusstringopcional
    • padrão "open"
    • um de"open""archived""all"
  • connectionIdstringopcional
    • tamanho 1–80
  • contactIdstringopcional
    • tamanho 1–80
  • updatedAfterstringopcional
  • cursorstringopcional
  • limitintegeropcional
    • padrão 50
    • faixa 1–100

Respostas

6 respostas documentadas — o código, o que ele significa nesta rota e a forma do corpo.

200Deu certoapplication/json

Conversas do Atendimento, da atualizada mais recentemente para a mais antiga (updatedAt DESC). nextCursor: null = acabou.

  • Cada item — V1Conversation

    • idstring
    • channelstring
    • connectionIdstring | null
    • contactIdstring | null
      • idstring
      • namestring
      • phonestring | null
      • emailstring | null
    • contactDisplaystring | null
    • contactPhonestring | null
    • assignedUserIdstring | null
    • humanAssignedboolean
    • assignedAtstring | null
    • lastMessageAtstring | null
    • lastMessageDirectionstring | null
      • um de"inbound""outbound"
    • lastMessageActorstring | null
      • um de"user""contact""ia""automation""system""api""unknown"
    • archivedboolean
      • pausedboolean
      • pausedUntilstring | null
      • pausedReasonstring | null
      • appliesboolean
      • openboolean
      • expiresAtstring | null
    • createdAtstring
    • updatedAtstring
  • nextCursorstring | null

    Cursor opaco da PRÓXIMA página — passe em ?cursor=. null = acabou a lista.