Skip to content

Quem está disponível e online agora

GET/api/chat/online

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Qualquer papel, **desde que a própria pessoa esteja disponível** (`chatAvailable`); senão 403. Só aparece quem ligou "Disponível para conversar" e está com o app aberto (último sinal nos últimos 90 s); nunca quem está indisponível, nem quem bloqueou ou foi bloqueado por quem pergunta. Cada pessoa traz `status` (`AVAILABLE`, `AWAY` ou `BUSY`; `AWAY` é o Ausente automático). Ordem por nome, 50 por página. `pagination.realtime = false` quando o tempo real está fora do ar (lista vazia).

Parameters

NameInTypeDescription
pageoptionalqueryinteger
limitoptionalqueryinteger

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

StatusDescription
200Pessoas online.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/chat/online" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"