Este endpoint permite envio de notificação ao determinado contato.
POST BASE_URL/notification/send
Base URL: Por favor faça login no seu backend DaSinal e vá ao menu "Definições -> aba "API Token" e veja o path completo e o Token de acesso.
Header:
Authorization: Bearer Token
Accept: application/json
lang: pt | en | es | fr
Content-Type: application/json
Request Body: Clique em (json) para ver o conteúdo.
REQUESTER PARAMETERS: Os parâmetros sinalizados com (*) são de preenchimento obrigatório.
|
|
- message *
|
text
Conteúdo da notificação.
|
|
- group_id
|
text
default: null
Permite agrupar notificação num referido identificador.
|
|
- type *
|
text
Valor: "sms;email;viber;whatsapp;messenger".
Indicar os tipos de notificação, separado por ";".
|
|
- priority
|
text
Valor: "sms;email;viber;whatsapp;messenger"
default:null
Defina prioridade de envio de notificação, será enviado somente para o primeiro da lista que respondeu com sucesso, os demais serão abortados. Ao não definir prioridades de envio, será enviado para todos os meios definido em "type".
|
|
- sent_at
|
text (date-time)
valor: "2020-07-23 14:56:33"
default: null
Data e hora em que a mensagem deve ser enviada. Usado para SMS agendado (SMS não enviado imediatamente, mas no horário agendado).
|
|
- confirmation
|
boolean
valor: "true", "false", 1, 0, "1", e "0"
default: "false"
Solicitar confirmação da notificação.
|
|
- confirmation_url
|
text
Ligação para confirmação da notificação.
|
|
- contact
|
array
Informação de contacto a ser notificado.
|
- calling_code
|
text
Código de chamada ou indicativo do país.
Obrigatório para quando o número de telefone for indicado.
|
|
- phone
|
text
Número de telefone a notificar.
Indicar o número sem indicativo.
|
|
- email
|
text
Email a ´receber notificação.
|
|
|
RESPONSE PARAMETERS: Clique em (json) para ver o conteúdo.
|
- status
|
boolean
true, false
|
|
- msg
|
text
Messagem de resposta Sucess | Error.
|
|
- result
|
object
Informação de do registo efetuado.
|
|
- notification
|
object
Informação de notificação
|
|
|
|
- code
|
text
Código de notificação registado.
|
|
- push
|
text
valor: FAIL | SENT
Estado de envio de tipo "push" de notificação.
|
|
- sms
|
text
valor: FAIL | SENT
Estado de envio de tipo "sms" de notificação.
|
|
- email
|
text
valor: FAIL | SENT
Estado de envio de tipo "email" de notificação.
|
|
- whatsapp
|
text
valor: FAIL | SENT
Estado de envio de tipo "whatsapp" de notificação.
|
|
- messenger
|
text
valor: FAIL | SENT
Estado de envio de tipo "messenger" de notificação.
|
|
- viber
|
text
valor: FAIL | SENT
Estado de envio de tipo "viber" de notificação.
|
|
|
|
|
|
|
Created with the Personal Edition of HelpNDoc: Full-featured Kindle eBooks generator
