Vai al contenuto

Limpa o histórico da conversa só para mim

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

Auth
Richiede un token
Chiave API:
Non accetta chiavi API
X-CommunityId
X-CommunityId Invia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.

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

Parametri

NomeDoveTipoDescrizione
idobbligatoriopathstring (uuid)

Header

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

Corpo della richiesta application/json

La specifica non dichiara i campi di questo corpo (un upload multipart, per esempio). Consulta la guida dell’argomento.

Risposte

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

Esempio 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 '{}'