Configurações

Consulta e altera as configurações de uma sessão, como filtros de mídia, grupos e presença automática.

Obter configurações

GET /sessions/{id}/config

Parâmetros

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da sessão (path param)

Request

cURL

curl https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config \
  -H "x-api-key: $WIAPI_KEY"

JavaScript

const response = await fetch(
  "https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config",
  { headers: { "x-api-key": process.env.WIAPI_KEY } }
);

const config = await response.json();

Python

import requests

response = requests.get(
    "https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config",
    headers={"x-api-key": WIAPI_KEY},
)

config = response.json()

Response

{
  "skipmedia": false,
  "skipgroups": false,
  "skipnewsletters": false,
  "skipbroadcasts": false,
  "skipownmessages": false,
  "skipcalls": false,
  "presence": true
}

Alterar configuração

POST /sessions/{id}/config/{key}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	ID da sessão (path param)
key	string	Sim	Chave da configuração (path param)
enabled	boolean	Sim	true para ativar, false para desativar

Chaves disponíveis

Chave	Efeito
skipmedia	Não recebe mídia nos webhooks (economiza banda)
skipgroups	Ignora mensagens de grupo
skipnewsletters	Ignora canais e newsletters
skipbroadcasts	Ignora listas de transmissão
skipownmessages	Não dispara webhook para mensagens enviadas
skipcalls	Ignora eventos de chamada
presence	Envia status “online” automaticamente

Request

cURL

curl -X POST https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config/skipgroups \
  -H "x-api-key: $WIAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

JavaScript

const response = await fetch(
  "https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config/skipgroups",
  {
    method: "POST",
    headers: {
      "x-api-key": process.env.WIAPI_KEY,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ enabled: true }),
  }
);

const result = await response.json();

Python

import requests

response = requests.post(
    "https://endpoint.wi.api.br/sessions/01234567-89ab-cdef-0123-456789abcdef/config/skipgroups",
    headers={"x-api-key": WIAPI_KEY},
    json={"enabled": True},
)

result = response.json()

Response

{
  "key": "skipgroups",
  "enabled": true
}