Este endpoint permite criar processo, evento/fase inicial e envio de notificação do registo de novo processo.
POST BASE_URL/process
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.
|
- process_definition_code
|
text
Código de tipo processo, se configurado na backend DaSinal.
|
|
- description *
|
text
Descrição do processo despoletado.
|
|
- url
|
text
Link com mais detalhes sobre o referido processo.
|
|
- requester
|
object
Informações do requerente do processo.
|
- name *
|
text
Nome requerente.
|
|
- address
|
text
Recebe Endereço do requerente.
|
|
- country_code
|
text
Consultar código dos países.
|
|
|
- notification
|
object
Informação de notificação.
|
- message *
|
text
Conteúdo da notificação.
|
|
- 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".
|
|
- send_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.
|
|
|
|
- phase
|
object
Fase / evento inicial, inserido com o registo do processo.
|
- phase_definition_code
|
text
Código de tipo de etapa associado ao registo do evento inicial.
|
|
- description *
|
text
Descrição do evento inicial.
|
|
- notes
|
text
Notas adicionais sobre o evento inicial.
|
|
- is_public
|
boolean
Valor: true, false, 1, 0, "1", e "0"
default: true
Indicar se o evento inserido pode ser de consulto pública.
|
|
RESPONSE PARAMETERS: Clique em (json) OU (xml) para ver o conteúdo.
|
- status
|
boolean
true, false
|
|
- msg
|
text
Messagem de resposta Sucess | Error.
|
|
- result
|
object
Informação de do registo efetuado.
|
- process_code
|
text
Código do processo registado.
|
|
- notification
|
object
Informação da notificação registado.
|
- code
|
text
Código de notificação registado.
|
|
- event
|
text
valor: FAIL | SENT
Estado de envio de tipo "event" de notificação.
|
|
- 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 multi-format Help generator
