Saltar al contenido

Quem está disponível e online agora

GET/api/chat/online

Auth
Requiere token
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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).

Parámetros

NombreDóndeTipoDescripción
pageopcionalqueryinteger
limitopcionalqueryinteger

Headers

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

Respuestas

CódigoDescripción
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.

Ejemplo con curl

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