Search docs/

Enviar notificação por público-alvo

{...}

Enviar notificações push e email para usuários dentro de um certo público-alvo via Web, Android e iOS.

POST https://api.layers.digital/v2/notification/send
CopiarCopiado

Autenticação

Autenticação do tipo Token Bearer é necessária para acessar essa rota.

Parâmetros

  • community-id
    (header)
    obrigatório
    Identificador da comunidade

Requisição

Especificação

  • targetsObjectobrigatório

  • titleStringREGRASAté 65 caracteres

    Título da notificação

  • bodyStringREGRASAté 178 caracteres

    Texto do corpo da notificação

  • actionObject

  • scheduleDateString

    Data em formato ISO8601 com o momento em que deve ser enviada a notificação. Caso o paramêtro não esteja presente, a notificação é enviada instantaneamente.

  • channelsObject

    Canais para envio de notificações - email/pushNotification

Exemplo

{
  "targets": {
    "topics": {
      "kind": "user",
      "community": "exemplo",
      "id": "exemplo",
      "name": "exemplo",
      "alias": "exemplo",
      "email": "exemplo"
    },
    "roles": [
      [
        "admin",
        "guardian",
        "student"
      ]
    ]
  },
  "title": "Título da minha Notificação",
  "body": "Corpo da minha notificação",
  "action": {
    "path": "/?postId=123456",
    "portalAlias": "@admin:layers-comunicados",
    "type": "portal"
  },
  "scheduleDate": "2030-09-07T15:50-03:00",
  "channels": {
    "pushNotification": {
      "title": "Título da minha Notificação",
      "body": "Corpo da minha notificação"
    },
    "email": {
      "title": "Título da minha Notificação",
      "body": "Corpo da minha notificação",
      "actionLabel": "Responder Comunicado",
      "backgroundUrl": "exemplo"
    }
  }
}
CopiarCopiado