SMS
🎯 Functional documentation
SMS providers are used to send out OTP codes to users, typically for authentication or verification purposes.
Several SMS providers can be configured per organization, each serving its own set of countries. The provider is
picked based on the country of the phone number the SMS is sent to: every provider lists the countries it serves in
SMS_COUNTRIES, and the provider that leaves SMS_COUNTRIES empty handles all remaining countries. Configuring one
provider for BE, a second for FR and a third without countries therefore sends Belgian numbers to the first,
French numbers to the second and everything else to the third. Sending fails when no provider serves the destination
country and there is no provider without countries to fall back on.
Most providers just deliver the message that Harmoney composed around the OTP code it generated itself. Providers that run their own verification service, such as the two Bird Verify providers below, instead generate, deliver and validate the code themselves, so the message content and the sender are configured at the provider rather than in Harmoney.
⚙️ Configuration
Settings Configuration
Examples
BirdPlatformVerifySmsSettings
Sends and validates the OTP code through the Verify API of platform.bird.com, which is a different Bird API. It
needs an API_KEY, and resourceUri selects the regional platform host (for example https://eu1.platform.bird.com);
the EU host is used when it is left empty.