Etiquetas e Filtros

Organize contatos e conversas com etiquetas. Crie filtros personalizados para visualizacoes especificas do seu fluxo de atendimento.

Etiquetas da Conta

Gerencie o catalogo de etiquetas da conta. As etiquetas criadas aqui podem ser aplicadas a contatos e conversas.

GET/api/v1/accounts/{account_id}/labels

Lista todas as etiquetas da conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/labels" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de etiquetas

json

{
  "payload": [
    {
      "id": 1,
      "title": "vip",
      "description": "Cliente prioritario",
      "color": "#FF6B6B",
      "show_on_sidebar": true
    }
  ]
}

POST/api/v1/accounts/{account_id}/labels

Cria uma nova etiqueta.

Body (envolto em objeto label)

Nome	Tipo	Obrigatorio	Descricao
`title`	`string`	Sim	Nome da etiqueta (sem espacos)
`description`	`string`	Nao	Descricao da etiqueta
`color`	`string`	Nao	Cor em hexadecimal
`show_on_sidebar`	`boolean`	Nao	Exibir na barra lateral

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/labels" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "label": {
      "title": "vip",
      "description": "Cliente prioritario",
      "color": "#FF6B6B",
      "show_on_sidebar": true
    }
  }'

PATCH/api/v1/accounts/{account_id}/labels/{id}

Atualiza uma etiqueta existente. Body envolto em objeto label.

DELETE/api/v1/accounts/{account_id}/labels/{id}

Remove uma etiqueta da conta. A etiqueta e desassociada de contatos e conversas.

Etiquetas de Contato

Tambem disponivel via endpoint de Contatos.

GET/api/v1/accounts/{account_id}/contacts/{id}/labels

Lista as etiquetas de um contato.

200Etiquetas do contato

json

{ "payload": ["vip", "lead-quente", "enterprise"] }

POST/api/v1/accounts/{account_id}/contacts/{id}/labels

Define as etiquetas de um contato (substitui todas as existentes).

Body

Nome	Tipo	Obrigatorio	Descricao
`labels`	`array`	Sim	Array de etiquetas (strings)

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/contacts/456/labels" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "labels": ["vip", "enterprise"] }'

Etiquetas de Conversa

GET/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels

Lista as etiquetas de uma conversa.

200Etiquetas da conversa

json

{ "payload": ["urgente", "bug-report"] }

POST/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels

Define as etiquetas de uma conversa.

Body

Nome	Tipo	Obrigatorio	Descricao
`labels`	`array`	Sim	Array de etiquetas

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/conversations/123/labels" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "labels": ["urgente", "bug-report", "escalar"] }'

Filtros Personalizados

Crie filtros salvos para acessar rapidamente conjuntos especificos de conversas.

GET/api/v1/accounts/{account_id}/custom_filters

Lista os filtros personalizados.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`filter_type`(query)	`string`	Nao	Tipo: conversation, contact ou report (padrao: conversation)

200Lista de filtros

json

[
  {
    "id": 1,
    "name": "VIP Pendentes",
    "filter_type": "conversation",
    "query": {
      "payload": [
        { "attribute_key": "status", "filter_operator": "equal_to", "values": ["pending"] },
        { "attribute_key": "labels", "filter_operator": "contains", "values": ["vip"] }
      ]
    }
  }
]

POST/api/v1/accounts/{account_id}/custom_filters

Cria um filtro personalizado.

Body (envolto em objeto custom_filter)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome do filtro
`filter_type`	`string`	Nao	Tipo: conversation, contact ou report (padrao: conversation)
`query`	`object`	Nao	Criterios do filtro (mesmo formato do endpoint /conversations/filter)

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/custom_filters" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "custom_filter": {
      "name": "VIP Pendentes",
      "filter_type": "conversation",
      "query": {
        "payload": [
          { "attribute_key": "status", "filter_operator": "equal_to", "values": ["pending"] }
        ]
      }
    }
  }'

PATCH/api/v1/accounts/{account_id}/custom_filters/{id}

Atualiza um filtro.

DELETE/api/v1/accounts/{account_id}/custom_filters/{id}

Remove um filtro.