[Beta]{class="badge informative"}
Configure a custom SMS provider sms-configuration-custom
Note that this Beta does not support inbound messages for opt-in/opt-out consent management and delivery reporting.
This feature empowers you to integrate and configure your own SMS providers, offering flexibility beyond the default providers (Sinch, Twilio, and Infobip). This enables seamless SMS authoring, delivery, reporting, and consent management.
With the custom provider configuration for SMS, you can:
- Configure custom SMS providers directly within Journey Optimizer.
- Use advanced payload customization for dynamic messaging.
- Manage consent preferences (opt-in/opt-out) to ensure compliance.
Create your API credential api-credential
To send messages in Journey Optimizer using a custom provider not available out of the box by 51ºÚÁϲ»´òìÈ (e.g., Sinch, Infobip, Twilio), follow these steps:
-
In the left rail, navigate to Administration
>Channels, select the API Credentials menu, and click the Create new API credentials button.
-
Configure your SMS API credentials, as detailed below:
-
SMS vendor: Custom.
-
Name: Enter a name for your API Credential.
-
Provider AppId: Enter the application ID provided by your SMS provider.
-
Provider Name: Enter the name of your SMS provider.
-
Provider URL: Enter the URL of your SMS provider.
-
Auth Type​: Select your authorization type and complete the corresponding fields based on the chosen authentication method.
-
-
In the Headers section, click Add new parameter to specify the HTTP headers for the request message that will be sent to the external service.
The Content-Type and Charset header fields are set by default and cannot be deleted.
-
Add your Provider Payload to validate and customize your request payloads.
You can dynamically personalize your payload using profile attributes, and ensure accurate data is sent for processing and response generation with the help of built-in helper functions.
-
Click Submit when you finished the configuration of your API credentials.
-
In the API Credentials menu, click the bin icon to delete your API credentials.
-
To modify existing credentials, locate the desired API credentials and click the Edit option to make the necessary changes.
After creating and configuring your API credential, you now need to create a channel surface for SMS messages. Learn more
Once configured, you can leverage all out-of-the-box channel capabilities such as message authoring, personalization, link tracking, and reporting.
Authentication options for custom SMS Providers auth-options
Once your API credential is created, complete the fields required for API key authentication:
- Name ​: Enter a name for your API key configuration.
- API Token ​: Enter the API Token provided by your SMS provider.
Once your API credential is created, complete the fields required for MAC authentication:
- Name ​: Enter a name for your MAC authentication configuration.
- API Token ​: Enter the API Token provided by your SMS provider.
- API Secret Key: Enter the API Secret Key provided by your SMS provider. This key is used to generate the MAC (Message Authentication Code) for secure communication.
- Mac Authorization Hash Format: Choose the hash format for the MAC authentication.
Once your API credential is created, complete the fields required for OAuth authentication:
-
Name ​: Enter a name for your OAuth authentication configuration.
-
API Token ​: Enter the API Token provided by your SMS provider.
-
OAuth URL ​: Enter the URL for obtaining the OAuth token.
-
OAuth Body ​: Provide the OAuth request body in JSON format, including parameters such as
grant_type,client_id, andclient_secret.
Once your API credential is created, complete the fields required for JWT authentication:
-
Name ​: Enter a name for your JWT authentication configuration.
-
API Token ​: Enter the API Token provided by your SMS provider.
-
JWT Payload ​: Enter the JSON payload containing the claims required for JWT, such as the issuer, subject, audience, and expiration.
How-to video video
