Beskrivning

Funktion som hanterar utgående kommunikation via e-post eller SMS.

Version 1 innefattar enklast möjliga variant på kommunikation - kommande versioner kan komma att innehålla:

till våra intressenter.

Kommunikationsmöjligheter:

• SMS
  se SmsSender

• E-post
  se EmailSender

• Webb-meddelanden
  se WebMessageSender

• Post (digital via DigitalMailSender om mottagaren har digital brevlåda, annars analog via SnailmailSender)

• Digital post och digitala fakturor
  se DigitalMailSender

• Slack
  se Slack

Bubblare:

• App-push

Dessutom sparas, för identifierade mottagare, kommunikationshistorik. 

Livscykelstatus

Under utveckling

Lösningsbeskrivning

Hantering av personuppgifter

Vilka personuppgifter hanteras och varför?

API-specifikation

För att skicka meddelanden görs ett POST-anrop till /messages. Mottagarna anges i form av en lista med personId, som messaging använder för att slå upp respektive mottagares återkopplingsinställningar från feedbacksettings. Anroparen kan skicka med både ett längre och ett kortare meddelande som används beroende på om mottagaren vill ha e-post eller SMS skickat till sig.

POST /messages

{
  "sender" : "Sundsvalls Kommun",
  "recipients" : [
    "15aee472-46ab-4f03-9605-68bd64ebc73f"
  ],
  "subject": "Ämnesrad för e-post",
  "message" : "Ett längre meddelande som kan skickas som e-post",
  "shortMessage" : "Ett kortare meddelande som kan skickas via SMS"
}

POST /messages/sms

{
  "sender" : "Sundsvalls Kommun"
  "mobileNumber" : "0701234567",
  "personId" : "435rfret45", //optional
  "message" : "Text. bla bla"
}

POST /messages/email

{
  "sender" : "Sundsvalls Kommun <noreply@sundsvall.se>",
  "emailAddress" : "test@test.se",
  "personId" : "435rfret45", //optional
  "subject": "Ämnesrad för e-postmeddelandet"
  "message" : "Text. bla bla",
  "htmlMessage": "<BASE64-encode:ad HTML>",
  "attachments" : [
    {
      "name": "<bilagans filnamn>",
      "contentType": "<bilagans content type>",
      "content": "<BASE64-encode:at filinnehåll>"
    },
    ...
  ]
}

GET /messages/status/{messageId}

[ <TODO> ]

GET /messages/{personId}/conversationHistory

[ <TODO> ]

Batchfunktionalitet

För att skicka stora batcher med meddelanden via antingen SMS eller E-post finns det två resurser tillgängliga:

• /sms/batch
• /email/batch

Båda är asynkrona och för att säkerställa att meddelanden skickats kan kommunikationshistorik hämtas via resursen /status. 

Spårbarhet

Samtliga endpoints under Sending Resource har stöd att ta emot x-origin och x-issuer som möjliggör en viss spårbarhet. x-origin representerar vilket system anropet skickades ifrån och x-issuer representerar vilken användare som skickat anropet.

Batchfunktionalitet

Livscykelstatus

Produktion

Lösningsbeskrivning

Hantering av personuppgifter

Meddelandehistorik sparas på person-id.

API-specifikation