Central de Ajuda

Tire suas dúvidas e aproveite ao máximo nossos serviços

/api/notificacao/notificar

Descrição: Envia uma notificação para um ou mais usuários por diferentes canais. A API SRS permite enviar notificações para usuários via WhatsApp, Teams, Email ou Portal.

Parâmetros de Entrada:
- Token (string) — Obrigatório — Token de autenticação para acessar a API.
- ExecucaoId (string) — Obrigatório — ID da execução associada à notificação.
- Assunto (string) — Obrigatório — Assunto da notificação.
- Mensagem (string) — Obrigatório — Conteúdo da mensagem a ser enviada.
- Canal (lista) — Obrigatório — Canais de envio (Whatsapp, Teams, Email, Portal).
- Destino (lista) — Obrigatório — Lista de destinatários (UsuarioId ou Token).
- Confidencial (int) — Opcional — Define se a mensagem é confidencial (0 = Não, 1 = Sim).

Exemplo de Requisição em Python:

import requests

url = "https://<srs-dominio>/api/notificacao/notificar"
payload = {
    "Token": "Xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "ExecucaoId": "exec_12345",
    "Assunto": "Atualização do Sistema",
    "Mensagem": "O sistema será atualizado hoje às 23h.",
    "Canal": ["Email", "Teams"],
    "Destino": [{"UsuarioId": "user_123"}, {"Token": "abcd-efgh-ijkl"}],
    "Confidencial": 1
}

response = requests.post(url, data=payload)
print(response.json())

Exemplo de Resposta:

{
  "Autorizado": true,
  "Mensagem": "Enviado com sucesso.",
  "Erro": []
}

Possíveis Erros:
- 401 – Unauthorized — Token ausente ou inválido.
- 403 – Acesso negado — O usuário autenticado não tem permissão para enviar notificações.
- 400 – Parâmetros inválidos — Algum parâmetro essencial está ausente ou mal formatado.
- 404 – Usuário não encontrado — Nenhum usuário válido foi identificado nos destinatários.

Central de Ajuda

Tire suas dúvidas e aproveite ao máximo nossos serviços

/api/notificacao/notificar

Sobre nós

Contact Info