v1

latestOpenAPI 3.0.02026-07-26626596.3 KB

Conversas

Buscar conversas

get/api/v1/conversations

Query parameters

skipnumber

takenumber

searchstring

openedboolean

Valor booleano para conversas em aberto. Por padrão o valor é true, caso o valor seja false retorna todas as conversas (incluindo finalizadas)

departmentsstring

ID ou Lista de IDs de departamentos.

Este campo aceita um único ou uma lista de IDs separados por vírgula

instancesstring

ID ou Lista de IDs de instâncias.

Este campo aceita um único ou uma lista de IDs separados por vírgula

tagsstring

ID ou lista de IDs de tags.

Este campo aceita um ID ou uma lista de IDs de tags separados por vírgula

stagesstring

ID do stage.

Este campo aceita um únido ID, referente a um estágio de pipeline

attendantsstring

ID ou Lista de IDs de atendentes.

Este campo aceita um único ou uma lista de IDs separados por vírgula

openWindow'last24h' | 'all'

Filtro de janela em aberto.

Valores aceitos: 'last24h' (mensagens recebidas nas últimas 24 horas) ou 'all' (todas as conversas)

{
  "opened": true,
  "departments": "e3581d38-aeab-483a-8275-de32dce2388a",
  "instances": "682f0a3823f2d4e36a2150c0,6808667d911e4c8975bc5405",
  "tags": "849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896",
  "stages": "849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896",
  "attendants": "849fefab-e697-4720-9303-e788c23790cc,9e008d34-86d2-49fd-90af-34a9f9b29896",
  "openWindow": "last24h"
}

Response

countnumber required