Kartra Documentation Technical Documentation for Kartra

SMS gateway

Here you will find any necessary information to setup a SMS gateway.

Please Note the following considerations:

1. Kartra integrates with three different SMS gateways: Twilio, Plivo and Nexmo. One of these services will be required to send SMS messages from Kartra directly. Here you can find direct links to our documentation to integrate each service:

2. Utilizing these gateways will involve a combination of using the specific service’s SMS settings and our own Kartra system.  In Kartra you will set up the API integration itself, but chances are that you might also need to configure some other parameters inside the gateway’s console.

3. Once the API data is entered in Kartra, you will be able to send yourself a test SMS to confirm that both applications are communicating with each other. Please ensure you complete at least one test to ensure your setup is working as intended before you start to use it within Kartra.

Test SMS 01

4. Some SMS services will charge based on the number of messages you send or have other types of limitations on their end (Such as a specific number of sends per month). Please ensure you are within your SMS account’s limits when you send messages from Kartra. As the Kartra software will not be able to determine if you hit these limits and will merely not send the messages or show an error.

5. When sending an SMS message there is a maximum limit of 127 characters that is universal to the entire SMS system as a whole. Our system does require seven or more characters to communicate the appropriate data via the API. So when you send messages from Kartra there may be a hidden limit on characters (Usually around 120), but this will vary based on your SMS service. As most messages sent in an SMS service that go over this character limit will just send a second message to accommodate for the size of the message.

Please Note: This does mean that you can send X messages via Kartra and it will show many more messages within your SMS based on how many characters were in your message. 241 characters as an example would require three messages within most SMS providers and result in 3x as many messages being sent via your SMS as shown in Kartra analytics (120 characters per message and the last message to contain the last 1 letter carry over) .

 

Twilio

Twilio integration will require a account SID and Auth. Token from Twilio to integrate into Kartra.

Please Note: This means most issues dealing with these tokens will need to be solved via Twilio and Twilio support.

How to setup your Twilio integration:

First you will need to go to the integration tab located via the left hand menu:

Integrations Tab 01

Select the three dots within the Twilio box inside the “Integrations” section of Kartra.

Twilio 01

Select the “+ New integration” option.  If you already have an integration setup, you will need to click the three dots within the previous integration to edit the previously made integration.

From here you will be presented with the following modal:

Twilio 02

At this point you will need to login to Twilio on a separate tab and collect the necessary information within Twilio.

After logging into Twilio, your dashboard will be presented with the following screen:

Twilio 03

Your necessary keys will be displayed on your dashboard.  Please ensure you are using the appropriate project (Twilio project) for your keys.

 

Please Note: Twilio may change their website from what appears in this document; but the information should still be obtainable through their system.

Once you collect and fill in all necessary information within Kartra, you can “create” your integration by clicking the green button. If the create button is not highlighted in green and still shows as grey, then you are missing data within the fields necessary to setup your integration.

Please Note: The “Send from” phone number may not be just some arbitrary number. Often SMS services provide you such a number to work with their system and you will need to inquire with your SMS provider’s support to ensure what phone number you should place here. In other words, this may not be purely aesthetic but is instead part of your setup process.

Please Note: At this point you should be able to test your SMS feature via the test option at the bottom of the window. Please ensure this feature sends you a message before you “create” your SMS integration. If no message is sent then your setup may have a typo or incorrect information and needs to be updated.

If you are unable to find the necessary token information on Twilio, please contact Twilio support to collect the necessary information.

If your Twilio API Key does not work via Kartra, please contact Kartra support: Support@Kartra.com

Plivo

Plivo integration will require a account Auth. ID and Auth. Token from Plivo to integrate into Kartra.

Please Note: This means most issues dealing with these codes will need to be solved via Plivo and Plivo support.

The first step in setting up your Plivo integration will be to access the “+ New integration” option within the Plivo setup:

Plivo 01

Upon creating a new Plivo integration you will be prompted with a screen to input your Plivo data:

Plivo 02

 

You will need to login to Plivo on a separate tab and collect the necessary information within Plivo.

After logging into Plivo, the necessary information will be displayed on your front dashboard or various other locations within Plivo.

Plivo 03

 

Your account Auth. ID and your token will then be displayed for you to use.

Please Note: Plivo may change their website from what appears in this document; but the information should still be obtainable through their system.

Meanwhile on the original tab with Kartra, you will need to copy the Account Auth. ID and Auth. Token into the modal window.  At this point the create option will enabled. By selecting create you can now finish your Plivo SMS gateway integration. If the create button is not lit up in green, then you have not completed filling in the necessary information.

Please Note: The “Send from” number is often generated by your SMS provider and sometimes cannot be an arbitrary number. Please check your SMS provider for details on what your “Send from” number should be.

If you are unable to find the necessary information (such as Authorization ID or token) on Plivo, please contact Plivo support.

If your Plivo Auth. ID and/or Token does not work via Kartra (but is accurate according to Plivo support), please contact Kartra support: Support@kartra.com

Nexmo

Nexmo integration will require a account API “Key” and API “Secret” code from Nexmo to integrate into Kartra.

Please Note: This means most issues will need to be solved via Nexmo and Nexmo support, if either of your codes are not working as intended.

To integrate your Nexmo SMS gateway you will want to go to the “Integrations” section of Kartra. This can be found in the menu bar on the left hand side of the Kartra interface (usually near the bottom).

Integrations Tab 01

Upon selecting the Nexmo option you will be presented with a link to this documentation and the ability to create a new Nexmo integration with Kartra (+ New integration). You are allowed to have multiple integrations within your Kartra account.

Nexmo 01

You will need to login to Nexmo on a separate tab and collect the necessary information within Nexmo itself to complete your setup.

After logging into Nexmo, the necessary information will be displayed on your front dashboard.

SMSGateway 09

Your account API Key and API Secret will then be displayed for you to use on their interface.

Please Note: Nexmo may change their website from what appears in this document; but the information required should always be the same and should still be obtainable through their system.

With this information you can then go back to your browser tab that contains Kartra and fill in the required information:

Nexmo 02

You will need to copy the Account API Key and API Secret into the modal window.  In addition you will want to name your SMS gateway as it will display in Kartra and provide a “Send from” phone number. At this point the create option will be enabled. By selecting create you can now finish your Nexmo SMS gateway integration. If the button is not enabled and green, then you have not filled in the necessary information to complete your setup.

Please Note: The “Send from” phone number may not be just some arbitrary number. Often SMS services provide you such a number to work with their system and you will need to inquire with your SMS provider’s support to ensure what phone number you should place here. In other words, this may not be purely aesthetic but is instead part of your setup process.

Please Note: At this point you should be able to test your SMS feature via the test option at the bottom of the window. Please ensure this feature sends you a message before you “create” your SMS integration. If no message is sent then your setup may have a typo or incorrect information and needs to be updated.

If you are unable to find the necessary information on Nexmo please contact Nexmo support to acquire what ever information you require.

If your Nexmo information does not work via Kartra (and it is confirmed accurate by their support), then please contact Kartra support: Support@kartra.com

© 2023 Kartra All Rights Reserved