51ºÚÁϲ»´òìÈ

DocumentationJourney OptimizerJourney Optimizer Guide

Configure a custom SMS provider sms-configuration-custom

Last update: Fri May 23 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Intermediate
  • Admin

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 and manage consent preferences (opt-in/opt-out) to ensure compliance.

To configure your custom SMS provider, follow the steps below:

  1. Create API Credential
  2. Create Webhook
  3. Create Channel configuration
  4. Create Journey or Campaign with SMS channel action

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:

  1. In the left rail, navigate to Administration > Channels, select the API Credentials menu under SMS settings, and click the Create new API credentials button.

  2. 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.

  3. 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.

  4. Add your Provider Payload to validate and customize your request payloads.

  5. Click Submit when you finished the configuration of your API credentials.

  6. In the API Credentials menu, click the bin icon to delete your API credentials.

  7. 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 set up the inbound settings for the Webhook for SMS messages.

Authentication options for custom SMS Providers auth-options

API key

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.

MAC authentication

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.

OAuth 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, and client_secret.

JWT authentication

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.

Create Webhook webhook

recommendation-more-help

If opt-in or opt-out keywords are not provided, standard consent messages are used to honor user privacy. Adding custom keywords automatically overrides the defaults.

Default keywords:

  • Opt-In: SUBSCRIBE, YES, UNSTOP, START, CONTINUE, RESUME, BEGIN
  • Opt-Out: STOP, QUIT, CANCEL, END, UNSUBSCRIBE, NO
  • Help: HELP
style
shade-box

Once your API credentials have been successfully created, the next step is to create a webhook and configure your inbound settings. This configuration ensures that your system can properly receive and process incoming data or messages.

  1. In the left rail, navigate to Administration > Channels, select the SMS Webhooks menu under SMS settings, and click the Create Webhook button.

  2. Configure your Webhook Settings, as detailed below:

    • Name: Enter a name for your Webhook.

    • Select SMS vendor: Custom.

    • Select API credentials: Choose from the drop-down you previously configured API credentials.

    • Opt-in Keywords: Enter the default or custom keywords that will automatically trigger your Opt-In Message. For multiple keywords, use comma-separated values.

    • Opt-in Message: Enter the custom response that is automatically sent as your Opt-In Message.

    • Opt-out Keywords: Enter the default or custom keywords that will automatically trigger your Opt-Out Message. For multiple keywords, use comma-separated values.

    • Opt-out Message: Enter the custom response that is automatically sent as your Opt-Out Message.

  3. Click View payload editor 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.

  4. Click Submit when you finished the configuration of your Webhook.

  5. In the Webhooks menu, click the bin icon to delete your Webhook.

  6. To modify existing configuration, locate the desired Webhook and click the Edit option to make the necessary changes.

  7. Access and copy your new Webhook URL from your previously submitted Webhook.

After creating and configuring the inbound settings for the Webhook, you now need to create a channel configuration for SMS messages.

Once configured, you can leverage all out-of-the-box channel capabilities such as message authoring, personalization, link tracking, and reporting.

How-to video video

video poster

b22c9c5d-9208-48f4-b874-1cefb8df4d76