Saltar al contenido

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

GET/api/notifications/sends/{sendId}

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.

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.

Parámetros

NombreDóndeTipoDescripción
sendIdobligatoriopathstring
statusopcionalqueryall | read | unread
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
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.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/notifications/sends/<sendId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"