Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
Funktion som hanterar utgående kommunikation till våra intressenter.
Kommunikationsmöjligheter:
E-post (implementerad)
Se emailSenderDigital post (under utveckling)
Se digitalMailSenderWebb-meddelanden (implementerad)
Se webMessageSender
Bubblare:
Analog post
se EmailSenderWebb-meddelanden
se WebMessageSenderPost (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
Gliffy | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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
Code Block | ||
---|---|---|
| ||
{
"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
Code Block | ||
---|---|---|
| ||
{
"sender" : "Sundsvalls Kommun"
"mobileNumber" : "0701234567",
"personId" : "435rfret45", //optional
"message" : "Text. bla bla"
} |
POST /messages/email
Code Block | ||
---|---|---|
| ||
{
"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}
Code Block | ||
---|---|---|
| ||
[ <TODO> ] |
GET /messages/{personId}/conversationHistory
Code Block | ||
---|---|---|
| ||
[ <TODO> ] |
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
(Ref: Säkerhetsklassning av APIer )
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/API
Ansvarigt team: Team Dynasty
För tekniska frågor: teamdynasty@sundsvall.se
Länkar
<Länkar till dev-portal;
Test
Sandbox
Produktion>
FAQ
<FAQ>
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
Gliffy | ||||||
---|---|---|---|---|---|---|
|
Hantering av personuppgifter
Meddelandehistorik sparas på person-id.
API-specifikation
Open api | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Säkerhetsklassning
Säkerhetsklass 1
Autentiseringsmetod: Oauth2
Teknisk ägare
Ansvarigt team: Team Unmasked
För tekniska frågor: teamunmasked@sundsvall.se