Pular para o conteúdo principal
GET
Consultar conversas com filtros flexíveis

Autorizações

x-api-key
string
header
obrigatório

Copy the API key as provided by the Bridge Console.

Parâmetros de caminho

workspaceId
string<uuid>
obrigatório

Identificador único do workspace (UUID v4).

Exemplo:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Parâmetros de consulta

limit
integer
padrão:20

Número de conversas por página

Intervalo obrigatório: 1 <= x <= 100
cursor
string | null

Cursor recebido na solicitação anterior para obter a próxima página

status
enum<string>

Status da conversa

Opções disponíveis:
ACTIVE,
GHOST,
RELEASED,
NOT_ASSIGNED_TO_HUMAN,
BLOCKED
internalUserIdentifier
string | null

Identificador do usuário interno. Ao enviar um número de telefone, codifique corretamente a URL da solicitação, incluindo seus parâmetros.

internalUserIdentifierType
enum<string>
Opções disponíveis:
ID,
EMAIL
externalUserIdentifier
string | null
externalUserIdentifierType
enum<string>
Opções disponíveis:
ID,
EMAIL,
PHONE

Resposta

Resposta bem-sucedida

Corpo da resposta para listar conversas com paginação.

conversations
ConversationResponse · object[]
obrigatório

Lista de conversas.

cursor
string | null

Cursor para obter a próxima página de conversas. É null quando não há mais páginas.

Exemplo:

null