The following article will describe how to configure your integration between OptiText and Infobip, one of our SMS partners.

If you would like to find out more about Infobip configuration and documentation, please visit their site here.

 

Configuring Your Infobip-Optimove Integration

To configure your Infobip integration with Optimove correctly, you will need to apply changes both in the Optimove UI and in your Infobip UI.

If you have any questions about the following steps, please reach out to your Customer Success Manager.

 

In the Optimove UI

First, navigate to the Settings area within Optimove, and click on SMS Config, under OptiText.

Here, you can access the configuration details by clicking on the cog icon.

When you have opened the SMS configuration, you will see 3 fields that you need to complete on the left-hand side and the Current Configuration panel on the right-hand side.

Please note:

The Current Configuration panel will only have the relevant details included if you have previously configured your SMS implementation.

 

Base URL

The Base URL points the Optitext integration to the correct Infobip endpoints. You can find the Base URL by navigating to https://www.infobip.com/docs/api. Log in and you will be able to see your API Key and Base URL. You will need to copy and paste this URL into your Optitext configuration settings.

 

API Key

The API key needs to be created from within the Infobip dashboard under Developer Tools -> API Keys. You can create keys in this view. Give it a name, set the roles to Public API and set an expiry date. Then hit generate. The generated key is what you will need to provide in the SMS Infobip configuration screen.

Given the API keys have an expiry date it is important to ensure they are kept up to date in your Optitext configuration.

API Key Scopes

Infobip have recently introduced scopes to their API token configuration settings. The video below outlines the necessary scopes for our integration:

Below is a list of the permissions that need to be selected:

General/Platform (REQUIRED):

1. message:send
2. account-management:manage
3. numbers:manage

Channels (REQUIRED ONLY for channels intended to be used):

1. whatsapp:logs:read
2. whatsapp:manage
3. whatsapp:message:send
4. sms:logs:read
5. sms:manage
6. sms:message:send
7. mms:logs:read
8. mms:manage
9. mms:message:send

For multibrand/multiregion support you also need to ensure you enable permissions to:

1. application-entity:manage
2. messages-api:manage
3. messages-api:message:send
4. sending-strategy:manage

 

From Number

The From number will be the primary number you will be sending SMS messages from. You can view all the numbers associated with your Infobip account here https://portal.infobip.com/apps/sms. You will need to copy and paste this Number into your OptiText configuration settings.

 

MMS Settings

To enable support for adding media to your OptiText templates, and thereby turning them into MMS campaigns, you need to add additional information as part of your OptiText configuration.

While in the same configuration modal in the Settings area, scroll to MMS Settings and switch the toggle to on.

Insert the From Number that you have set up with Infobip. Please check your configuration with your Infobip Account Manager to ensure that the From Number is enabled to send MMS campaigns. 

Click Configure to confirm. You will now be able to create MMS via the OptiText template builder. 

Please note:

MMS is only supported via Infobip for campaigns in Canada and the United States. 

 

Sending to Multiple Regions

There may be cases where you want to send OptiText campaigns from different numbers, depending on the region you are targeting. For example, you should have separate numbers for targeting US, UK, and Brazil markets individually. The following section outlines how to configure your Optimove Infobip integration to support sending to multiple regions.

When sending to a single region, you can include the From number as part of your Infobip configuration. The From number must be from the same region that you intend on sending it to.

 

To implement using different From Numbers for different regions, and in doing so improve deliverability rates in the specific regions you are targeting, you first need to ensure this is configured with Infobip. Reach out to your Infobip account manager to ensure that you have the relevant numbers purchased and configured, before returning to the Optimove configuration.

 

Configuring Multiple Regions in Infobip

To begin with, you should create a new Entity for your brand with Infobip. You can do this by going to the ‘Applications and Entities’ menu option on the left of your Infobip dashboard and then selecting the ‘Entities’ tab. From here click the ‘Create Entity’ button and complete the form.

 

 In the example below we have created a single Entity to represent our brand.

 

Within that brand Entity, you need to associate your sending numbers. You do this by clicking on the Entity that represents your brand and choosing ‘Associate Resource’. In the example below we are selecting a UK number to send messages to the UK. We will also associate a US number as we will also be sending to the US.

If you are using an alphanumeric sender ID, please request from your Infobip representative to associate it with the entity ID you've defined.

 

Configuring Multiple Regions in Optimove

Now that your Entity is configured with Infobip and you have associated your sending numbers with it, you can return to the OptiText Infobip configuration dialog, and instead of specifying a From number you will instead specify the Entity ID instead. This value should be the Entity ID of the entity that you created earlier. In our case “Brand1”.

 

Infobip is currently not capable of automatically choosing the correct number for the recipient. So, to do this we need to create a sending strategy for your Entity. This means that when Optimove sends a campaign to Infobip using the Entity, Infobip will know which numbers to use to send to which regions. Optimove will configure this for you on your behalf during onboarding.

 

For us to do so you will need to share with us the countries that you intend on sending to and their respective sending number(s). You will be provided with a form during onboarding, where you can share the countries you are targeting and their respective sending number(s). You can do this by completing the form given to you during onboarding. See an example of this form below:

 

We will then configure the strategy as part of your onboarding. You will need to wait for the strategy to be set before beginning to send any multi-region campaigns.

 

Please note:

All numbers purchased with Infobip must be configured with a Callback URL, to allow customers to opt out. In the example below you can see we have set the callback for our UK sending number. Ensure that you use the correct callback URL for the brand against which the number is being used.

When sending multi-region campaigns with multiple brands, you should ensure that brand entities are configured correctly, including the numbers required for multi-region sends. Then you would set your configuration to use the appropriate Entity ID. See Supporting Multiple Brands. 

 

Supporting Multiple Brands

If you intend on using the same Infobip account for multiple brands, then there is some additional configuration that needs to be done.

Infobip supports this with Entities and Sending Strategies. If you intend on sending multi-region campaigns, we recommend that for every brand you intend sending multi-region campaigns for, you create a separate entity in your Infobip dashboard. 

 

Each entity should contain the numbers that you wish to be available for sending campaigns for the intended brand. These numbers need to be configured with the respective brand callback URL. This can be found in the SMS Configuration dialog for each brand.

 

You should ensure that numbers are assigned to one entity/brand only to ensure correct reporting and opt out. Numbers cannot be shared across brands.

 

Configuring Multiple Brands in Infobip

You should work with Infobip to define your entities and ensure the correct number resources are purchased and allocated to the right entity.

For your brand, you should create a new Entity. You can do this by going to the ‘Applications and Entities’ menu option on the left of your Infobip dashboard and then selecting the ‘Entities’ tab. From here click the ‘Create Entity’ button and complete the form.

 

 In the example below we have created a single Entity to represent our brand.

 

Now within that brand Entity, you need to associate your sending numbers. You do this by clicking on the Entity that represents your brand and choosing ‘Associate Resource’. In the example below we are choosing a UK number as we intend on sending messages to the UK. We will also associate a US number as we are also going to be sending to the US.

 

You can repeat the above steps to create Entities and Resource Associations for all your brands.

Now that your Entity is configured and you have associated sending numbers with it, you can return to the Optitext Infobip configuration dialog, and instead of specifying a From number you will instead specify the Entity ID instead. This value should be the Entity ID of the entity that you created earlier. In our case “Brand1”.

That Entity and its number resources will then be used for sending campaigns for that brand.

 

Infobip currently is not capable of automatically choosing the correct number for the recipient. So, to do this we need to create a sending strategy for your Entity. This means that when we send a campaign using the Entity, Infobip will know which numbers to use to send to which regions. Optimove will configure this for you on your behalf. For us to do so you will need to communicate to us the countries that you intend on sending to and their respective sending number(s). You can do this by completing the form given to you during onboarding. 1 form for each entity. The numbers specified must be associated with the entity.

 

We will then configure the strategy as part of the onboarding flow. You will need to wait for the strategy to be set before sending any multi-brand campaigns.

 

Please note: 

For single-region brands specifying the From number will be enough. You should ensure that the From number can send to your campaign’s intended region. From numbers cannot be shared across multiple brands.