Install and configure SMS Relentless
You can install SMS Relentless like any other Hub for Teams application. Click on the profile picture from the upper right corner > Apps > search for ‘SMS Relentless’ using the search box on the upper bar > click ‘Download and enable’
Next, configure SMS Relentless first by entering your credentials and options on the admin settings page of the app: click on the profile picture > Administration settings > then, on the
left panel under ‘Administration’ click ‘SMS Relentless: On this page, you can fill in your credentials from one or multiple providers (Telnyx/Plivo/Twilio/Flowroute), depending on whose services you want to use. The fields should be filled in as follows:
Telnyx Settings
- in the Telnyx API Secret Key field enter your Telnyx API Key: log in to Telnyx, then, on the‘Home’ page, in the ‘API Keys’ section from the upper right corner, click on ‘Manage Keys: If you already have an API key, just copy it by clicking the ‘Copy to clipboard’ icon. Otherwise, to create an API key, click the ‘Create API Key’ button, on the pop up message click ‘Create’ then copy the Key and enter it in the Telnyx API Secret Key field.
- in the Telnyx Account Public Key field enter the public key necessary to verify the signature of the incoming SMS messages: while logged in to Telnyx, on the ‘Home’ page, in the ‘API Keys’ section from the upper right corner, click on ‘Manage Keys, then click on ‘Public Key’ on the upper bar, then copy the key from the ‘Key’ field and enter it in the Telnyx Account Public Key field.
- in the Messaging Profile ID enter the messaging profile ID that you will be using (you can
have multiple phone numbers associated with the same messaging profile ID): while logged in to Telnyx, click on ‘Messaging’ on the left panel, click on the name of the messaging profile that you want to use, then under ‘Profile ID’ you will find the messaging profile ID. Copy it and enter it in the Messaging Profile ID field.
- in the Telnyx webhook URL for incoming SMS/MMS field enter the webhook URL for incoming messages. You have to first generate and then copy this URL into your Telnyx
account, so that Telnyx knows where to deliver the SMS/MMS messages received by your Telnyx phone number(s). First generate the URL by pressing the ‘Generate new webhook URL for incoming SMS/MMS’ button, copy it, then, in your Telnyx account click on ‘Messaging, then on ‘Programmable Messaging’ on the left panel, click on the name of the messaging profile that you associated with your phone number(s), then, under ‘Inbound Settings; enter the webhook URL generated here in the field ‘Send a webhook to this URL; then click ‘Save’.
- in the Telnyx webhook URL for delivery receipts field enter the webhook URL for the delivery receipts that you will receive for sent messages. This URL will be included by SMS Relentless in message sending requests, so that Telnyx knows where to send the delivery receipts. Just generate it by pressing the ‘Generate new webhook URL for delivery receipts’ button. You don’t have to enter this URL into your Telnyx account.
- in the Telnyx alphanumeric Sender ID field you can enter an alphanumeric sequence of up to 11 characters in the range of a-z, A-Z, 0-9 and space, if you intend to use an alphanumeric Sender ID. In certain countries there are regulations that accept only shorter alphanumeric Sender IDs, such as up to 6 characters. You cannot send SMS/MMS messages with alphanumeric Sender IDs to USA or Canada. There are even countries that require preregistration of alphanumeric Sender IDs. Before sending SMS/MMS messages to a country it's recommended to read the country specific features and restrictions. Some carriers won't accept messages with an alphanumeric Sender ID.
- under Allow the following groups and non-admin users to send and receive messages using ... you can choose any available groups and non-admin users to share your Telnyx credentials (mentioned in the fields from above) with them. In this way, they can use the phone numbers associated with those Telnyx credentials, to send and receive messages, without having their own Telnyx accounts and credentials.
Plivo Settings
- in the Plivo Auth ID field enter your Plivo Auth ID: log in to Plivo, then, on the first page which is the Overview page, under Account, copy the ‘Auth ID’
- in the Plivo Auth Token field enter the auth token: while logged in to Plivo, on the Overview
page, under Account, copy the ‘Auth Token’
— in the Plivo webhook URL for incoming SMS/MMS field enter the webhook URL for incoming messages. You have to first generate and then copy this URL into your Plivo account so that Plivo knows where to deliver the SMS/MMS messages received by your Plivo phone number(s). First generate the URL by pressing the ‘Generate new webhook URL for incoming SMS/MMS’ button, copy it, then, in your Plivo account click on ‘Messaging’ on the left vertical bar, click on ‘Applications, then, under ‘Application name’ click on ‘Inbound_SMS_Messages; next, under ‘Message; enter the webhook URL generated earlier in the field ‘Message URL’ and select ‘POST’ next to it, then click the ‘Update Application’ button.
- in the Plivo webhook URL for delivery receipts field enter the webhook URL for the delivery receipts that you will receive for sent messages. This URL will be included by SMS Relentless in message-sending requests so that Plivo knows where to send the delivery receipts. Just generate it by pressing the ‘Generate new webhook URL for delivery receipts’ button. You don’t have to enter this URL into your Plivo account.
- in the Plivo alphanumeric Sender ID field you can enter an alphanumeric sequence of up to 11 characters in the range of a-z, A-Z, 0-9 and space if you intend to use an alphanumeric
Sender ID. In certain countries, there are regulations that accept only shorter alphanumeric Sender IDs, such as up to 6 characters. You cannot send SMS/MMS messages with alphanumeric Sender IDs to USA or Canada. There are even countries that require
- under Allow the following groups and non-admin users to send and receive messages using ... you can choose any available groups and non-admin users to share your Plivo
credentials (mentioned in the fields from above) with them. In this way, they can use the phone numbers associated with those Plivo credentials, to send and receive messages, without having their own Plivo accounts and credentials.
Twilio Settings
- in the Twilio Account SID field enter your Twilio Account SID: log in to Twilio, then, on the first page, under Account Info, copy the ‘Account SID’
- in the Twilio Auth Token field enter your Auth Token: while logged in to Twilio, on the first page, under Account Info, copy the ‘Auth Token’
- in the Twilio webhook URL for incoming SMS/MMS field enter the webhook URL for
incoming messages. You have to first generate and then copy this URL into your Twilio account, so that Twilio knows where to deliver the SMS/MMS messages received by your Twilio phone number(s). First generate the URL by pressing the ‘Generate new webhook URL for incoming SMS/MMS ' button, copy it, then, in your Twilio account click on ‘Phone Numbers’ on the left panel > ‘Manage’ > ‘Active numbers; click on the phone number you want to use for SMS/MMS, scroll down to the ‘Messaging’ section, then under ‘A MESSAGE COMES IN’ select ‘Webhook, then paste in the webhook URL that you have just generated and select ‘HTTP POST’ as the request type. Enter the same data under ‘PRIMARY HANDLER FAILS; then click the ‘Save’ button. If you have multiple SMS/MMS enabled phone numbers, do the same for each number.
- in the Twilio webhook URL for delivery receipts field enter the webhook URL for the delivery receipts that you will receive for sent messages. This URL will be included by SMS Relentless in message sending requests, so that Twilio knows where to send the delivery receipts. Just generate it by pressing the ‘Generate new webhook URL for delivery receipts’ button. You don’t have to enter this URL into your Twilio account.
- in the Twilio alphanumeric Sender ID field you can enter an alphanumeric sequence of up to 11 characters in the range of a-z, A-Z, 0-9 and space, if you intend to use an alphanumeric Sender ID. In certain countries there are regulations that accept only shorter alphanumeric Sender IDs, such as up to 6 characters. You cannot send SMS/MMS messages with alphanumeric Sender IDs to USA or Canada. There are even countries that require preregistration of alphanumeric Sender IDs. Before sending SMS/MMS messages to a country, it's recommended to read the country specific features and restrictions. Some carriers won't accept messages with alphanumeric Sender IDs.
- under Allow the following groups and non-admin users to send and receive messages using ... you can choose any available groups and non-admin users to share your Twilio credentials (mentioned in the fields from above) with them. In this way, they can use the phone numbers associated with those Twilio credentials, to send and receive messages, without having their own Twilio accounts and credentials.
Flowroute Settings
- in the Flowroute Access Key field enter your Acess Key: log in to Flowroute. On the leftpanel, click on ‘Preferences; then on the ‘API Control’ tab. Scroll down to the ‘API Keys’ section. If you already have a pair of keys listed in that section, just copy the Access Key to the field from below. If you haven't created any keys yet, to create a key pair, under ‘Add new API Key; in the ‘Name’ field, enter a name for the new key pair. In the ‘Description’ field enter a short description, then click ‘Add new: A new pair of keys will be created and you will be prompted to copy the Secret Key. Copy it in a safe location.
- in the Flowroute Secret Key field enter the Secret Key that you created earlier.
- in the Flowroute webhook URL for incoming SMS/MMS field enter the webhook URL for incoming messages. You have to first generate and then copy this URL into your Flowroute account, so that Flowroute knows where to deliver the SMS/MMS messages received by your Flowroute phone number(s). First generate the URL by pressing the button from below, copy it, then, in your Flowroute account click on ‘Preferences’ on the left panel, then click on the ‘API Control tab’ turn on the ‘SMS’ switch and in the field that shows up enter the URL that you have just generated. Click ‘Save URL: If you have an MMS enabled phone number, turn on the ‘MMS’ switch, enter the same URL in the URL field and save it. Also, under ‘SMS Webhook Version’choose ‘v2.1.
- in the Flowroute webhook URL for delivery receipts field enter the webhook URL for the delivery receipts that you will receive for sent messages. This URL will be included by SMS Relentless in message sending requests, so that Flowroute knows where to send the delivery receipts. Just generate it by pressing the ‘Generate new webhook URL for delivery receipts’ button. You don't have to enter this URL into your Flowroute account.
Flowroute only supports sending/receiving SMS/MMS messages within USA and Canada and it doesn’t support Alphanumeric Sender IDs.
- under Allow the following groups and non-admin users to send and receive messages using ... you can choose any available groups and non-admin users to share your Flowroute credentials (mentioned in the fields from above) with them. In this way, they can use the phone numbers associated with those Flowroute credentials, to send and receive messages, without having their own Flowroute accounts and credentials.
- if you shared your Telnyx/Plivo/Twilio/Flowroute API credentials with one or multiple non-admin users, you can check the checkbox In my message tables, list not only my messages but also the messages of all the Hub for Teams users with whom | share the access keys mentioned above, to include in message tables all the messages of the non-admins who used your phone numbers to send and receive messages.
- under Restrict access to the following phone numbers, you can restrict shared phone
numbers to specific groups or non-admin users. When a shared phone number is restricted to a specific user, that user will be able to see and use only that phone number and not the other phone numbers associated with the same Telnyx/Plivo/Twilio/Flowroute API credentials. Also, the other users with whome the same API credentials were shared, won't be able to see and use the phone number restricted to the mentioned user. You can restrict the same number to multiple users and you can restrict multiple numbers to the same user. When a number is restricted to a specific group, all the users in that group are treated as if the number was restricted to each of them.
Click ‘Save’ at the bottom of the page, to save all the settings to the database.
Next, you can access the personal settings page (on the left panel, under Personal, click SMS
Relentless) and enter your options there:
- in the Number of messages per page field enter the number of messages to be displayed on one page of the received and sent messages tables. If you don’t enter anything in this field, the default of 100 messages per page will be used.
- in the Number of archived conversations to display field enter the number of archived
conversations that will be listed on the Conversations page. To list all the archived
conversations, leave this field empty.
- in the Time interval in seconds before checking for new messages field enter the number of seconds before the app checks the database in the background to find if a new message has arrived, so as to know if it needs to refresh the list of received messages. If you leave this field empty, the default of 5 seconds will be used.
- check the Show the display name of the message author, before each message checkbox if you want the display name of the message author to be displayed before each message.
- you can have the display name of the message author included in the text of the message
itself, if you check the Include the display name of the message author in the text of the message itself, if you check the include the display name of the message author in the text of the message itself checkbox
- check the I want to see a notification in Hub for Teams when a new SMS/MMS is received
checkbox if you want to see Hub for Teams notifications when new SMS/MMS messages arrive.
- if you want to enable email notifications enter your email address in the I want to receive a notification to the email address from below, when a new SMS/MMS is received field.
- if you want the SMS/MMS message to be included in the email notification, check the Include
the SMS/MMS message in the email notification itself checkbox.
- under Set auto-reply messages for the following phone numbers you can choose any
available phone number and configure an auto-reply message for it. Auto-reply messages can be set up in ‘daily mode’, when you want the messages to be sent every day outside a specified time interval, or in ‘vacation mode’, when you want the messages to be sent inside a time interval specified by two dates.
Click ‘Save’ to save all the settings to the database.
