Send e-post med filreferanser

Slik sender du sammensatte e-postbestillinger med filreferanser i sammensatt Varslings-API-et.

Når du tester og overvåker sammensatte e-postbestillinger, kan du slå opp detaljerte beskrivelser av ordre‑ og varslingsstatus i referansen for statusverdier for ordre og varsler.

Forutsetninger

Før du starter, må du ha:

1. En Maskinporten-klient med scopet altinn:serviceowner/notifications.composedemail.create
2. Et Altinn-token for autentisering mot API-et
3. Filer lastet opp i Azure Blob Storage
4. En SAS-URL for hver fil du vil legge ved

API-endepunkt

Altinn Notifications tilbyr ett endepunkt for sammensatte e-postbestillinger:

Base URL:

• Test (TT02): https://platform.tt02.altinn.no/notifications/api/v1
• Produksjon: https://platform.altinn.no/notifications/api/v1

Send sammensatt e-postbestilling

Forespørselstruktur

{
  "idempotencyId": "string",
  "sendersReference": "string (valgfri)",
  "requestedSendTime": "2026-07-01T10:00:00Z",
  "recipient": {
    "emailAddress": "string",
    "emailSettings": {
      "subject": "string",
      "body": "string",
      "contentType": "Plain",
      "attachments": [
        {
          "filename": "string",
          "mimeType": "string",
          "sasUrl": "https://..."
        }
      ]
    }
  }
}

Felter

idempotencyId (påkrevd)

• Type: String
• Beskrivelse: Unik identifikator for denne sendingen. Brukes for å sikre at samme melding ikke sendes flere ganger ved gjentatte forespørsler.
• Eksempel: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

sendersReference (valgfri)

• Type: String
• Beskrivelse: Din egen referanse for denne sendingen. Brukes til logging og sporing.
• Eksempel: "ref-2026-001"

requestedSendTime (valgfri)

• Type: DateTime (UTC)
• Beskrivelse: Ønsket sendetidspunkt for varslingsbestillingen.
• Eksempel: "2026-07-01T10:00:00Z"

emailAddress (påkrevd)

• Type: String
• Beskrivelse: Mottakerens e-postadresse.
• Eksempel: "recipient@example.com"

subject (påkrevd)

• Type: String
• Beskrivelse: E-postens emnefelt.
• Eksempel: "Vedtak i saken din"

body (påkrevd)

• Type: String
• Beskrivelse: Innholdet i e-posten.
• Eksempel: "Se vedlagte dokument."

contentType (valgfri)

• Type: String
• Verdier: "Plain" eller "Html"
• Standard: "Plain"
• Beskrivelse: Innholdstype for e-postens innhold.

attachments (valgfri)

• Type: Array
• Beskrivelse: Liste over filreferanser som legges ved e-posten. Hvis feltet utelates, er null eller er tomt, sendes e-posten uten vedlegg.

filename (påkrevd når vedlegg er med)

• Type: String
• Beskrivelse: Filnavn for vedlegget.
• Validering: Må ikke inneholde skilletegn i filbaner (/, \) og må ha filendelse.
• Eksempel: "vedtak.pdf"

mimeType (påkrevd når vedlegg er med)

• Type: String
• Beskrivelse: MIME-type for vedlegget.
• Validering: Må være støttet av Azure Communication Services.
• Eksempel: "application/pdf"

sasUrl (påkrevd når vedlegg er med)

• Type: String (absolutt URI)
• Beskrivelse: SAS-URL som API-et bruker til å hente filen ved sending.
• Eksempel: "https://youraccount.blob.core.windows.net/container/vedtak.pdf?se=...&sp=r&sr=b&sig=..."

Valideringskrav

Krav til SAS-URL

Ved API-grensen blir hver SAS-URL for vedlegg kontrollert mot disse kravene:

Krav til vedlegg

Eksempel: Send sammensatt e-post med vedlegg

curl -X POST "https://platform.tt02.altinn.no/notifications/api/v1/future/orders/composed-email" \
  -H "Authorization: ******" \
  -H "Content-Type: application/json" \
  -d '{
    "idempotencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sendersReference": "ref-2026-001",
    "requestedSendTime": "2026-07-01T10:00:00Z",
    "recipient": {
      "emailAddress": "recipient@example.com",
      "emailSettings": {
        "subject": "Vedtak i saken din",
        "body": "Se vedlagte dokument.",
        "contentType": "Plain",
        "attachments": [
          {
            "filename": "vedtak.pdf",
            "mimeType": "application/pdf",
            "sasUrl": "https://youraccount.blob.core.windows.net/container/vedtak.pdf?se=2026-07-01T12%3A00%3A00Z&sp=r&sr=b&sig=..."
          }
        ]
      }
    }
  }'

Respons

Ved vellykket registrering får du 201 Created med sporingsidentifikatorer:

{
  "notificationOrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "notification": {
    "shipmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sendersReference": "ref-2026-001"
  }
}

Hvis du sender samme forespørsel på nytt med samme idempotencyId, returnerer API-et 200 OK med samme responsinnhold.

Feilhåndtering

Mulige feilkoder:

Neste steg

• API-referanse
• OpenAPI-spesifikasjon