Skip to content

Segmentar Público-alvo

Ao enviar uma notificação, deve-se especificar roles (perfis) e topics (tópicos) dentro de targets simultaneamente. A segmentação permite envios amplos ou altamente específicos.

Definindo Tópicos (target.topics)

Um tópico para notificação pode ser um user, member ou group, e pode ser especificado por id, alias ou email (no caso de ser um user).

Essa tabela mostra alguns exemplos de tópicos (usar na chave target.topics)

CenárioTopics
1 usuário por ID
Notifica um usuário específico pelo ID
[{"kind": "user", "id": "61087e1a608106241d30a8aa"}]
1 usuário por email
Notifica um usuário específico pelo email
[{"kind": "user", "email": "maria@exemplo.com"}]
2 usuários simultâneos
Notifica múltiplos usuários por email
[{"kind": "user", "email": "maria@exemplo.com"}, {"kind": "user", "email": "joao@exemplo.com"}]
1 aluno por alias
Notifica um membro específico pelo alias
[{"kind": "member", "alias": "aluno-joao-silva"}]
1 turma por alias
Notifica todos os membros de uma turma
[{"kind": "group", "alias": "turma-3a"}]
Exemplo misto
Notifica uma turma inteira e um usuário específico
[{"kind": "group", "alias": "turma-3a"}, {"kind": "user", "email": "diretor@exemplo.com"}]

Definindo Perfis (target.roles)

Quando notificar para member ou group, é obrigatório especificar também os perfis que serão notificados (roles). Isso é necessário porque podem haver diversos tipos de usuários vinculados à um membro ou grupo na Layers, os perfis são usados para filtrar esses usuários antes de enviar a notificação.


Exemplo

A requisição envia uma notificação para o seguinte público-alvo: responsáveis (guardian) relacionados a membros do grupo com alias turma-3a.

bash
curl -X POST https://api.layers.digital/v2/notification/send \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Community-Id: escola-exemplo" \
  -d '{
    "targets": {
      "topics": [{"kind": "group", "alias": "turma-3a"}],
      "roles": ["guardian"]
    },
    "title": "Aviso Importante",
    "body": "As aulas serão suspensas amanhã devido ao feriado"
  }'