SMS-udbyder

FoxIDs understøtter afsendelse af SMS-beskeder med Access URL, Gateway API, Smstools og Telia SMS Gateway. SMS-udbyderen kan konfigureres som en SMS-udbyder i hvert environment eller generelt i FoxIDs site-konfigurationen.

FoxIDs sender SMS-beskeder til brugere med verifikationskoder, passwordless login og multi-faktor-autentificering, når SMS er aktiveret i login-flowet.

FoxIDs indeholder standard SMS-udbydere til understøttede udbyder-API'er og en generisk Access URL SMS-udbyder til udbydere, der ikke er indbygget. Brug standardudbyderne, når udbyderens API matcher en af de understøttede integrationer. Brug Access URL, når udbyderen kan modtage et HTTPS GET request med udbyderspecifikke query-parametre.

Access URL

Access URL-udbyderen er en generisk udbyder til fleksible SMS-integrationer. Den kalder et udbyderspecifikt HTTPS endpoint med de query-parametre, som den konkrete SMS-udbyder kræver. API URL'en er en absolut HTTPS base URL uden query-parametre. Query-parametre konfigureres separat og kan bruge faste værdier eller placeholders.

Understøttede placeholders:

• {phone} - brugerens telefonnummer.
• {message} - SMS-beskedens tekst.
• {fromName} - det konfigurerede SMS-afsendernavn.

Eksempel på Access URL-konfiguration:

• API URL: https://some-provider.dk/sms/
• username = xxxxxx
• password = yyyyyy
• recipient = {phone}
• from = zzzzzz eller {fromName}
• message = {message}

FoxIDs sender requestet som HTTP GET og URL-encoder hver query-parameterværdi. API URL'en logges sammen med telefonnummeret. Query-parametre logges ikke. Hvis udbyderen returnerer en fejl, logger FoxIDs telefonnummeret, SMS-beskeden, HTTP-statuskoden og udbyderens response.

Konfigurer SMS-udbyder i environment

SMS-udbyderen kan konfigureres i hvert environment, hvor afsendernavnet er påkrævet. Hvis en SMS-udbyder er konfigureret i environment, bruges den i stedet for en generelt konfigureret SMS-udbyder.

Access URL

Konfigurer Access URL med en API URL og de query-parametre, som SMS-udbyderen kræver. API URL'en skal være en absolut HTTPS base URL uden query-parametre. Tilføj hver query-parameter separat, og brug placeholders der hvor værdien skal indsættes ved afsendelse.

Påkrævede værdier:

• Type: AccessUrl
• Afsendernavn
• API URL
• Query-parametre med mindst én {phone} placeholder og én {message} placeholder

Gateway API

Konfigurer Gateway API med udbyderens endpoint og token. Afsendernavnet sendes som SMS-afsender, og det valgfrie label sendes til Gateway API.

Påkrævede værdier:

• Type: GatewayApi
• Afsendernavn
• API URL
• Client secret

Valgfrie værdier:

• Label

Smstools

Konfigurer Smstools med udbyderens endpoint, client ID og client secret. Afsendernavnet sendes som SMS-afsender.

Påkrævede værdier:

• Type: Smstools
• Afsendernavn
• API URL
• Client ID
• Client secret

Telia SMS Gateway

Konfigurer Telia SMS Gateway med udbyderens endpoint, sender address, API key og mTLS-certifikat. Afsendernavnet sendes som SMS-afsendernavn, og client ID sendes som sender address.

Påkrævede værdier:

• Type: TeliaSmsGateway
• Afsendernavn
• API URL
• Client ID (sender address)
• Client secret (API key)
• mTLS-certifikat

Konfigurer SMS-udbyder generelt

SMS-udbyderen kan valgfrit konfigureres generelt i FoxIDs sitets application settings. Afsendernavnet er påkrævet.

API URL'en skal være en absolut HTTPS URL for alle SMS-udbydere. For Access URL skal API URL'en også være en base URL uden query-parametre, og query-parametrene skal indeholde mindst én {phone} placeholder og én {message} placeholder.

Access URL

Konfiguration af Access URL med application settings:

"Settings": {
  "Sms": {
    "Type": "AccessUrl",
    "FromName": "My-sender",
    "ApiUrl": "https://some-provider.dk/sms/",
    "Parameters": [
      {
        "Name": "username",
        "Value": "xxxxxx"
      },
      {
        "Name": "password",
        "Value": "yyyyyy"
      },
      {
        "Name": "recipient",
        "Value": "{phone}"
      },
      {
        "Name": "from",
        "Value": "{fromName}"
      },
      {
        "Name": "message",
        "Value": "{message}"
      }
    ]
  }
}

Konfigurer Access URL query-parametre i Parameters. Hver parameter har et Name og en Value. Query-parametrene skal indeholde mindst én {phone} placeholder og én {message} placeholder. Placeholders {phone}, {message} og {fromName} kan bruges i parameterværdier.

Gateway API

Konfiguration af Gateway API med application settings:

"Settings": {
  "Sms": {
    "Type": "GatewayApi",
    "FromName": "My-sender",
    "ApiUrl": "https://gatewayapi.eu/rest/mtsms",
    "ClientSecret": "gateway-api-token",
    "Label": "FoxIDs"
  }
}

ClientSecret sendes som Gateway API-token. Label er valgfrit.

Smstools

Konfiguration af Smstools med application settings:

"Settings": {
  "Sms": {
    "Type": "Smstools",
    "FromName": "My-sender",
    "ApiUrl": "https://app.smstools.com",
    "ClientId": "client-id",
    "ClientSecret": "client-secret"
  }
}

Telia SMS Gateway

Konfiguration af Telia SMS Gateway med application settings:

"Settings": {
  "Sms": {
    "Type": "TeliaSmsGateway",
    "FromName": "My-sender",
    "ApiUrl": "https://smsgw.teliamobile.dk:12123/messaging/v1/outbound/12345/requests",
    "ClientId": "12345",
    "ClientSecret": "b7dc08b6-54c8-46c2-ba37-21855d0acca4",
    "CertificatePemCrt": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
    "CertificatePemKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
  }
}

ClientId sendes som sender address. ClientSecret sendes som API key. Certifikatet og den private nøgle bruges til mTLS.

Relateret dokumentation

• E-mail-udbyder
• To-faktor og multi-faktor-autentificering
• Login & HRD
• Udrulning