Saltar al contenido

Pessoas disponíveis para conversar (painel lateral)

GET/api/chat/members

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 com a mesma mensagem de `/online`. Lista todas as pessoas da comunidade que ligaram "Disponível para conversar", online ou não; quem está indisponível **nunca** aparece, nem quem pergunta, nem quem bloqueou ou foi bloqueado por quem pergunta. Ordem: primeiro a equipe (`isTeam`: owner, admin, moderador e financeiro), depois as demais pessoas; dentro de cada grupo, online primeiro e depois por nome (A→Z). Paginação por cursor (`pagination.nextCursor`, até 50 por página) e busca por nome em `q`. `online` vem do registro de presença (último sinal nos últimos 90 s); `pagination.realtime = false` quando o tempo real está fora do ar (todos `online: false`). `canStart` diz se quem pergunta pode abrir conversa nova (regra "Quem pode iniciar conversas" e, no modo `CONNECTION`, conexão aceita, que não é pedida para quem é da equipe: a linha com `isTeam: true` vem com `canStart: true` mesmo com `connection: none`); conversa já existente continua aberta mesmo com `canStart: false` (no modo `CONNECTION`, só leitura sem conexão). `connection` diz a conexão com cada pessoa (`none`, `pending_out`, `pending_in`, `connected`). No modo `CONNECTION`, quem não está conectado vem com `limited: true` e `lastSeenAt: null` (só o cartão: nome, foto, frase, cargo); a equipe vê tudo. Nesse modo, para quem não é da equipe, `q` busca só no nome mostrado (o `displayName`, ou o nome da conta quando não há apelido).

Parámetros

NombreDóndeTipoDescripción
qopcionalquerystringBusca por nome (parte do nome, sem diferenciar maiúsculas). Quem não é da equipe casa só com o nome mostrado (`displayName`, ou o nome da conta quando não há apelido); ninguém busca por e-mail.
cursoropcionalquerystringO `nextCursor` da página anterior.
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 disponíveis, a equipe primeiro e, em cada grupo, online primeiro.
400Requisição inválida — falha de validação.
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/members" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"