APIs

NotifyUser

133 views 17/03/2020 28/08/2020 sergio-souza 0

NotifyUser

Envia notificação para um usuário
Payload de entrada
{
"Origem da notificação. Texto livre. Exemplo: Tenants, Usuários, Gestão de portaria. Obrigatório."
notificationOrigin : "string",

"Tipo da Notificação. Podendo ser Operational, Management, News. Obrigatório."
notificationKind : "string",

"Prioridade da Notificação. Podendo ser Error, Alert, None. Obrigatório."
notificationPriority : "string",

"Assunto da notificação. Obrigatório."
notificationSubject : "string",

"Texto da notifição. Obrigatório."
notificationContent : "string",

"Classe da notificação, utilizado para identificar o contexto/grupo de notificações . Opcional"
notificationClass: "string",

"Dominio de origem. Obrigatório."
sourceDomain : "string",

"Serviço de origem. Obrigatório. Exemplo: tenant-service"
sourceService : "string",

"Usuário destinatário da notificação. Obrigatório."
destinationUser : "string",

"Relação de usuários destinatários da notificação. Opcional."
destinationUsers : ["string", "string"],

"Link que será aberto ao click na notificação. Opcional. Este link é adicionado a URL da plataforma Ex: link:google.com.br ao click o usuário e redirecionado para uma nova aba com o https://platform.senior.com.br/tecnologia/platform/notifications/google.com.br."
link : "string"
}
Request
curl --location --request POST https://api.senior.com.br/platform/notifications/actions/notifyUser --header "Content-Type: application/json" --header "Accept: application/json" --header "Authorization: Bearer {access_token}" --data-raw "{ 'notificationOrigin': {string}, 'notificationKind': {string}, 'notificationPriority': {string}, 'notificationSubject': {string}, 'notificationContent': {string}, 'sourceDomain': {string}, 'sourceService': {string}, 'notificationClass': {string}, 'destinationUser': {string} }"
Response
  • 200 Ok
{
"ok": true
}
  • 400 Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente

Este artigo foi útil para você?