Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
<FAQ>

Beskrivning

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

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

  • Mallhantering

  • Kivra

  • Skicka fysiska brev

    till våra intressenter.

    Kommunikationsmöjligheter:

    Bubblare:

    • App-push

    Dessutom sparas, för identifierade mottagare, kommunikationshistorik. 

    Livscykelstatus

    Design

    Lösningsbeskrivning

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

    API specifikation

    Förslag (exempel):

    POST /sms

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

    POST /email

    Code Block
    languagejson
    {
      "sender" : "noreply@sundsvall.se"
      "emailAddress" : "test@test.se",
      "personId" : "435rfret45", //optional
      "message" : "Text. bla bla"
    }

    GET /{personId}/conversationHistory

    Code Block
    languagejson
    [ {
      "sender" : "Sundsvalls Kommun"
      "messageType" : "sms",
      "message" : "Text. bla bla"
    } ]

    API-ägare

    <Kontaktuppgifter till den verksamhet som äger APIets livscykel>

    Teknisk ägare

    <Kontaktuppgifter till utvecklare/teknisk förvaltare>

    Länkar

    <Länkar till dev-portal;

    • Test

    • Sandbox

    • Produktion>

    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
    displayNamemessagingAPI Copy
    namemessagingAPI Copy
    pagePin6


    Hantering av personuppgifter

    Meddelandehistorik sparas på person-id.

    API-specifikation

    Open api
    showCommonExtensionstrue
    deepLinkingtrue
    supportedSubmitMethodsnone
    locationurl
    showExtensionstrue
    urlhttps://api-test.sundsvall.se/messaging/api-docs



    Säkerhetsklassning

    Säkerhetsklass 1

    Autentiseringsmetod: Oauth2

    Teknisk ägare

    Ansvarigt team: Team Unmasked

    För tekniska frågor: teamunmasked@sundsvall.se 

    Källkod

    Github

    FAQ