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:

Bubblare:

  • Analog post

  • App-push

Dessutom sparas, för identifierade mottagare, kommunikationshistorik.

Livscykelstatus

Under utveckling

Lösningsbeskrivning

Gliffy
imageAttachmentIdatt29425686
macroId5403c848-f47c-4944-9cae-039096781462
baseUrlhttps://sundsvall.atlassian.net/wiki
namemessagingAPI
diagramAttachmentIdatt30179333
containerId30081025
timestamp1641819939751

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
languagejson
{
  "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
languagejson
{
  "sender" : "Sundsvalls Kommun"
  "mobileNumber" : "0701234567",
  "personId" : "435rfret45", //optional
  "message" : "Text. bla bla"
}

POST /messages/email

Code Block
languagejson
{
  "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
languagejson
[ <TODO> ]

GET /messages/{personId}/conversationHistory

Code Block
languagejson
[ <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>

Create from Template
spaceKeySK
templateName22151177
templateId22151177
buttonLabelSkapa från Template