SMS-provider

FoxIDs ondersteunt het verzenden van SMS-berichten met Access URL, Gateway API, Smstools en Telia SMS Gateway. De SMS-provider kan worden geconfigureerd als SMS-provider in elke omgeving of algemeen in de FoxIDs siteconfiguratie.

FoxIDs stuurt SMS-berichten naar gebruikers voor verificatiecodes, passwordless login en multi-factor authenticatie wanneer SMS is ingeschakeld in de login-flow.

FoxIDs bevat standaard SMS-providers voor ondersteunde provider-API's en een generieke Access URL SMS-provider voor providers die niet zijn ingebouwd. Gebruik de standaardproviders wanneer de provider-API overeenkomt met een van de ondersteunde integraties. Gebruik Access URL wanneer de provider een HTTPS GET-request met providerspecifieke queryparameters kan ontvangen.

Access URL

De Access URL-provider is een generieke provider voor flexibele SMS-integraties. Deze roept een providerspecifiek HTTPS-endpoint aan met de queryparameters die de concrete SMS-provider vereist. De API URL is een absolute HTTPS base URL zonder queryparameters. Queryparameters worden apart geconfigureerd en kunnen vaste waarden of placeholders gebruiken.

Ondersteunde placeholders:

• {phone} - het telefoonnummer van de gebruiker.
• {message} - de tekst van het SMS-bericht.
• {fromName} - de geconfigureerde SMS-afzendernaam.

Voorbeeld van Access URL-configuratie:

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

FoxIDs verzendt het request als HTTP GET en URL-encodeert elke queryparameterwaarde. De API URL wordt samen met het telefoonnummer gelogd. Queryparameters worden niet gelogd. Als de provider een fout retourneert, logt FoxIDs het telefoonnummer, het SMS-bericht, de HTTP-statuscode en de response van de provider.

SMS-provider in omgeving configureren

De SMS-provider kan in elke omgeving worden geconfigureerd, waarbij de afzendernaam verplicht is. Als een SMS-provider in de omgeving is geconfigureerd, wordt deze gebruikt in plaats van een algemeen geconfigureerde SMS-provider.

Access URL

Configureer Access URL met een API URL en de queryparameters die de SMS-provider vereist. De API URL moet een absolute HTTPS base URL zonder queryparameters zijn. Voeg elke queryparameter apart toe en gebruik placeholders waar de waarde bij verzending moet worden ingevoegd.

Verplichte waarden:

• Type: AccessUrl
• Afzendernaam
• API URL
• Queryparameters met ten minste één {phone} placeholder en één {message} placeholder

Gateway API

Configureer Gateway API met het provider-endpoint en token. De afzendernaam wordt verzonden als SMS-afzender, en het optionele label wordt naar Gateway API verzonden.

Verplichte waarden:

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

Optionele waarden:

• Label

Smstools

Configureer Smstools met het provider-endpoint, client ID en client secret. De afzendernaam wordt verzonden als SMS-afzender.

Verplichte waarden:

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

Telia SMS Gateway

Configureer Telia SMS Gateway met het provider-endpoint, sender address, API key en mTLS-certificaat. De afzendernaam wordt verzonden als SMS-afzendernaam, en de client ID wordt verzonden als sender address.

Verplichte waarden:

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

SMS-provider algemeen configureren

De SMS-provider kan optioneel algemeen worden geconfigureerd in de application settings van de FoxIDs-site. De afzendernaam is verplicht.

De API URL moet voor alle SMS-providers een absolute HTTPS URL zijn. Voor Access URL moet de API URL ook een base URL zonder queryparameters zijn, en de queryparameters moeten ten minste één {phone} placeholder en één {message} placeholder bevatten.

Access URL

Access URL configureren met 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}"
      }
    ]
  }
}

Configureer Access URL-queryparameters in Parameters. Elke parameter heeft een Name en een Value. De queryparameters moeten ten minste één {phone} placeholder en één {message} placeholder bevatten. De placeholders {phone}, {message} en {fromName} kunnen in parameterwaarden worden gebruikt.

Gateway API

Gateway API configureren met application settings:

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

ClientSecret wordt verzonden als Gateway API-token. Label is optioneel.

Smstools

Smstools configureren met application settings:

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

Telia SMS Gateway

Telia SMS Gateway configureren met 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 wordt verzonden als sender address. ClientSecret wordt verzonden als API key. Het certificaat en de privésleutel worden gebruikt voor mTLS.

Gerelateerde documentatie

• E-mailprovider
• Twee-factor- en multi-factor authenticatie
• Login & HRD
• Deployment