Saltar al contenido

Limpa o histórico da conversa só para mim

POST/api/chat/conversations/{id}/clear

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.

Só as duas pessoas da conversa (qualquer outra pessoa, de qualquer papel, recebe 404). Marca `clearedAt` para quem chama: as mensagens criadas até esse momento deixam de voltar **para essa pessoa** no histórico (`GET .../messages`), na prévia (`lastMessage`), nas não lidas (`unreadCount`) e no aviso por e-mail. A outra pessoa continua vendo tudo e não é avisada; nada é apagado. Mensagens novas aparecem normalmente. Funciona em qualquer modo, sem conexão e com bloqueio. Chamar de novo limpa até o novo momento. As outras abas de quem chamou recebem `conversation.cleared` (`{ conversationId, clearedAt }`).

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

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.

Cuerpo de la solicitud application/json

La especificación no declara los campos de este cuerpo (una subida multipart, por ejemplo). Consulta la guía del tema.

Respuestas

CódigoDescripción
200Histórico limpo para quem chamou.
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.
404Recurso não encontrado.
500Erro interno do servidor.

Ejemplo con curl

curl -X POST "https://api.memberfy.net/api/chat/conversations/<id>/clear" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'