Configure SMS Provider¶
Configurations related to SMS providers are located under the Notification Channels section.
Supported Providers¶
Asgardeo supports Twilio, Vonage, or custom SMS providers by default. To learn how to configure each provider, please see the relevant section.
Configuring Twilio
To configure Twilio as your SMS provider, follow the steps below:
- Go to Twilio and create an account.
- After signing up for your account, navigate to the Phone Numbers page in your console. You’ll see the phone number that has been selected for you. Note the phone number’s capabilities, such as "Voice", "SMS", and "MMS".
- After signing up, navigate to the Phone Numbers page in your console and note the phone number’s capabilities.
- Get your first Twilio phone number and use that as the “Sender” in the settings. For more information, see this tutorial in the Twilio documentation.
- Copy the Account SID and Auth Token from the Twilio console dashboard.
- Go to SMS Provider section in the Asgardeo Console and click the Twilio tab and fill the required fields.
| Name | Description | Example |
|---|---|---|
| Twilio Account SID | Account SID received in the previous step. | YourAccountSID |
| Twilio Auth Token | Auth token received in the previous step. | YourAuthToken |
| Sender | Phone number that you received when creating the Twilio account. | +1234567890 |
Configuring Vonage
To configure Vonage as your SMS provider, follow the steps below:
- Login to Vonage and create an account.
- Fill in the required fields and create the account.
- Login to the Vonage dashboard and copy the API Key and API Secret.
- Go to SMS Provider section in the Asgardeo Console and click the Vonage tab and fill the required fields.
| Name | Description | Example |
|---|---|---|
| Vonage API Key | Use the API Key from the previous step. | YourAPIKey |
| Vonage API Secret | Use the API Secret from the previous step. | YourAPISecret |
| Sender | The number that the receiver will see when you send an SMS. | +1234567890 |
Configuring a Custom Provider
If you are not using either Twilio or Vonage as the SMS provider, you can configure a custom SMS provider. Custom SMS provider configuration will pass the SMS data to the given URL as an HTTP request.
To configure a custom SMS provider, in the SMS Provider section click the Custom tab and fill the required fields.
| Name | Description | Example |
|---|---|---|
| SMS Provider URL | URL of the SMS gateway where the payload should be published. | https://api.example.com/api/v1 |
| Content Type | Content type of the payload. Possible values are JSON or FORM (Optional). |
JSON |
| HTTP Method | HTTP method that should be used when publishing the payload to the provider URL. Possible values: PUT, POST (Optional). |
POST |
| Payload Template | How the payload template should be. Placeholders: {{body}} - Generated body of the SMS. (Example - This can be the OTP). {{mobile}} - Number that this sms should be sent to. |
Example JSON payload template: {“content”: {{body}},“to”: {{mobile}}}}({{mobile}} and {{body}} will be replaced with the corresponding values at the runtime.) |
| Headers | Custom static headers need to be passed. If multiple headers need to be passed, they should be comma separated. (Optional) | authorisation: qwer1234asdfzxcv, x-csrf: true, x-abc: some-value |