Vai al contenuto

Quem abriu e quem não abriu um envio de avisos do sino

GET/api/notifications/sends/{sendId}

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.

A equipe (owner, admin, moderador) lê um envio de avisos do sino da comunidade do `X-CommunityId`: o aviso da equipe (`POST /api/notifications/send`, que devolve o `sendId`), o de um workflow (o `sendId` é a execução) e o lembrete de confirmação de leitura de um post (`POST /api/content/{id}/acknowledgements/remind`). "Abriu" é o aviso marcado como lido (`readAt`). Cada pessoa vem com `read`, `readAt` e `removed` (ela apagou o aviso do sino; continua contada). Membro e financeiro: 403. Envio de outra comunidade ou que não existe: 404.

Parametri

NomeDoveTipoDescrizione
sendIdobbligatoriopathstring
statusfacoltativoqueryall | read | unread
pagefacoltativoqueryinteger
limitfacoltativoqueryinteger

Header

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

Risposte

CodiceDescrizione
200O envio com as contagens (sempre do envio inteiro) e a página de pessoas.
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 GET "https://api.memberfy.net/api/notifications/sends/<sendId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"