-
Notifications
You must be signed in to change notification settings - Fork 10.4k
[ADD] sms marketing: added essentials/getting started docs #2553
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,4 +13,5 @@ SMS Marketing | |
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| sms_marketing/essentials | ||
| sms_marketing/pricing | ||
12 changes: 12 additions & 0 deletions
12
content/applications/marketing/sms_marketing/essentials.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| :nosearch: | ||
|
|
||
| ========== | ||
| Essentials | ||
| ========== | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| essentials/sms_essentials | ||
| essentials/sms_campaign_settings | ||
| essentials/mailing_lists_blacklists |
145 changes: 145 additions & 0 deletions
145
...nt/applications/marketing/sms_marketing/essentials/mailing_lists_blacklists.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| ============================ | ||
| Mailing lists and blacklists | ||
| ============================ | ||
|
|
||
| Creating or importing mailing lists in Odoo is very useful when curating content to specific groups | ||
| of people that already share similar demographics or interests. Mailing lists are also a great way | ||
| to get started if a company is migrating from another system, and already has a established | ||
| audience. | ||
|
|
||
| Moreover, providing an audience with the option to 'unsubscribe' from mailings, helps businesses | ||
| maintain good customer relations, by giving recipients the power to control what they are (and | ||
| aren't) sent. | ||
|
|
||
| Mailing lists | ||
| ============= | ||
|
|
||
| In the :guilabel:`SMS Marketing` app, there's an option on the header menu called :guilabel:`Mailing | ||
| Lists`. When clicked, a sub-menu is revealed with options for :guilabel:`Mailing Lists` and | ||
| :guilabel:`Mailing List Contacts`. | ||
|
|
||
| Click :menuselection:`Mailing Lists --> Mailing Lists` to see an overview of all mailing lists in | ||
| the database. | ||
|
|
||
| .. image:: mailing_lists_blacklists/mailing-list-main-page.png | ||
| :align: center | ||
| :alt: View of the main SMS mailing list page on the Odoo SMS Marketing application. | ||
|
|
||
| To edit any existing list, select the desired list from the :guilabel:`Mailing Lists` page, and | ||
| proceed to modify it in a number of ways. | ||
|
|
||
| To create a new mailing list, click :guilabel:`Create` in the upper left corner of the | ||
| :guilabel:`Mailing Lists` page. Doing so, will reveal a blank mailing list template form. | ||
|
|
||
| .. image:: mailing_lists_blacklists/sms-mailing-list-popup.png | ||
| :align: center | ||
| :alt: View of the mailing list pop-up window in Odoo SMS Marketing. | ||
|
|
||
| First, choose a name for the :guilabel:`Mailing List`, and activate the option :guilabel:`Is | ||
| Public`, to make the mailing list accessible to recipients on the :guilabel:`Subscription Management | ||
| page`. Doing so allows users to update their subscription preferences at any time. | ||
|
|
||
| .. note:: | ||
| Checking the :guilabel:`Is Public` box is not required, but is recommended to maintain good | ||
| customer relations. | ||
|
|
||
| When those fields are filled in, click :guilabel:`Create` to finalize the form. Then on the main | ||
| :guilabel:`Mailing Lists` dashboard, the new mailing list that was just created will be accessible. | ||
|
|
||
| To edit or customize the mailing list further, select the mailing list from the main | ||
| :guilabel:`Mailing Lists` page to reveal the mailing list detail form. | ||
|
|
||
| Along the top of the mailing list detail form, there are various analytical smart buttons displaying | ||
| statistics for different metrics related to the mailing list (e.g. :guilabel:`Recipients`, | ||
| :guilabel:`Mailings`, etc.). | ||
|
|
||
| To review or edit any of those elements, click the desired smart button to reveal a separate page | ||
| with in-depth data associated with the mailing list. | ||
|
|
||
| To make changes to the mailing list itself, click the :guilabel:`Edit` button in the upper-left | ||
| corner of the mailing list detail form. | ||
|
|
||
| .. image:: mailing_lists_blacklists/sms-mailing-list.png | ||
| :align: center | ||
| :alt: View of the mailing list template form in Odoo SMS Marketing. | ||
|
|
||
| .. note:: | ||
| Don't forget to hit the :guilabel:`Save` button once changes have been made. | ||
|
|
||
| Mailing lists contacts | ||
| ====================== | ||
|
|
||
| Access contacts information from one or more mailing lists navigate to :menuselection:`Mailing Lists | ||
| --> Mailing List Contacts` to reveal a dashboard with with all the contacts associated with one or | ||
| more of the configured mailing lists in the database. | ||
|
|
||
| .. image:: mailing_lists_blacklists/mailing-list-contacts-page.png | ||
| :align: center | ||
| :alt: View of the mailing lists contact page in the Odoo SMS Marketing application. | ||
|
|
||
| .. note:: | ||
| By default, Odoo reveals the :guilabel:`Mailing List Contacts` page with the :guilabel:`Exclude | ||
| Blacklisted Phone` filter in the search bar. Therefore only showing contact information for | ||
| recipients who still want to receive communications and mailings. | ||
|
|
||
| Communication history in the Chatter | ||
| ------------------------------------ | ||
|
|
||
| An accessible record of every sent mailing(s) is kept on each recipient's *chatter* section, located | ||
| beneath a recipient's contact form (in the *Contacts* application). | ||
|
|
||
| Database users can reference the chatter to easily keep track of communications, and see a history | ||
| of interactions with contacts and prospects. | ||
|
|
||
| For example, sales representatives can use the chatter to quickly find out which :abbr:`SMS (Short | ||
| Message Service)` mailing promotions a certain customer has received (or not received). | ||
|
|
||
| .. image:: mailing_lists_blacklists/sms-marketing-chatter.png | ||
| :align: center | ||
| :alt: View of what the chatter looks like in the Odoo Contacts app. | ||
|
|
||
| Blacklist | ||
| ========= | ||
|
|
||
| Odoo *SMS Marketing* has a :guilabel:`Blacklist` feature that provides recipients with the power to | ||
| add their phone number to a list of people who no longer want to receieve communications or | ||
| mailings. | ||
|
|
||
| This is also known as the unsubscribe process: customers will automatically be added onto a | ||
| *blacklist*, if they click :guilabel:`Unsubscribe`, via their :guilabel:`Subscription Management` | ||
| page. Customers can also be added manually to the blacklist, if necessary. | ||
|
|
||
| To see a complete collection of blacklisted numbers, navigate to the :menuselection:`SMS Marketing | ||
| app --> Configuration --> Blacklisted Phone Numbers` to reveal a dashboard containing every | ||
| blacklisted phone number in the database. | ||
|
|
||
| .. image:: mailing_lists_blacklists/sms-blacklist-menu.png | ||
| :align: center | ||
| :alt: SMS Blacklist menu in the application. | ||
|
|
||
| To manually add a number to a blacklist, click the :guilabel:`Create` button in the upper-left | ||
| corner of the dashboard and enter the phone number on the next page's form. There's also a | ||
| checkbox to indicate whether that particular phone numnber is :guilabel:`Active` (or not). | ||
|
|
||
| .. image:: mailing_lists_blacklists/sms-blacklist-create.png | ||
| :align: center | ||
| :alt: SMS Blacklist menu in the application. | ||
|
|
||
| Once the form is completed, click :guilabel:`Save` to add it to the :guilabel:`Blacklisted Phone | ||
| Numbers` list. To remove any number from the blacklist, select the desired number on the dashboard, | ||
| and then, on the phone number's form, click :guilabel:`Unblacklist`. | ||
|
|
||
| Importing blacklists | ||
| -------------------- | ||
|
|
||
| During a software/platform migration, it is possible to import an already existing blacklist of | ||
| contacts. This would include customers, who have already asked to be blacklisted` on :abbr:`SMS | ||
| (Short Message Service)` mailings. | ||
|
|
||
| To do that, navigate to :menuselection:`SMS Marketing app --> Configuration --> Blacklisted Phone | ||
| Numbers`, and then select the :guilabel:`Favorites` drop-down menu (beneath the search bar), and | ||
| click :guilabel:`Import records`. | ||
|
|
||
| .. image:: mailing_lists_blacklists/import-blacklist.png | ||
| :align: center | ||
| :alt: View of how to import a blacklist in Odoo SMS Marketing. |
Binary file added
BIN
+21.6 KB
...arketing/sms_marketing/essentials/mailing_lists_blacklists/import-blacklist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+24.3 KB
...ms_marketing/essentials/mailing_lists_blacklists/mailing-list-contacts-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+19.3 KB
...ng/sms_marketing/essentials/mailing_lists_blacklists/mailing-list-main-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+23.6 KB
...ting/sms_marketing/essentials/mailing_lists_blacklists/sms-blacklist-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+21.8 KB
...keting/sms_marketing/essentials/mailing_lists_blacklists/sms-blacklist-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+7.92 KB
...ng/sms_marketing/essentials/mailing_lists_blacklists/sms-mailing-list-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+24 KB
...arketing/sms_marketing/essentials/mailing_lists_blacklists/sms-mailing-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+14.6 KB
...ing/sms_marketing/essentials/mailing_lists_blacklists/sms-marketing-chatter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
158 changes: 158 additions & 0 deletions
158
content/applications/marketing/sms_marketing/essentials/sms_campaign_settings.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| ===================== | ||
| SMS campaign settings | ||
| ===================== | ||
|
|
||
| Utilizing :abbr:`SMS (Short Message Service)` campaigns with Odoo *SMS Marketing* isn't just an | ||
| effective advertisement strategy, it's also a great way to remind people about upcoming events, | ||
| issued invoices, and so much more. | ||
|
|
||
| But, before :abbr:`SMS (Short Message Service)` campaigns can be created (and sent), a few specific | ||
| settings and features must be enabled first. | ||
|
|
||
| SMS campaign setting | ||
| ==================== | ||
|
|
||
| To enable :abbr:`SMS (Short Message Service)` campaigns in Odoo, make sure the *Mailing Campaigns* | ||
| feature is activated by going to :menuselection:`Email Marketing --> Configuration --> Settings`, | ||
| and then enable :guilabel:`Mailing Campaigns` and :guilabel:`Save` the changes. | ||
|
|
||
| .. image:: sms_campaign_settings/sms-mailing-campaigns.png | ||
| :align: center | ||
| :alt: View of the mailing campaigns setting in Odoo. | ||
|
|
||
| .. note:: | ||
| Activating the *Mailing Campaigns* feature in the *General Settings* also enables the *A/B Test* | ||
| feature. | ||
|
|
||
| Once the setting is enabled, navigate back to the :menuselection:`SMS Marketing` app, and notice the | ||
| :guilabel:`Campaigns` header menu is now available for use. Similarly, the :guilabel:`A/B Test` tab | ||
| is now also available on every :abbr:`SMS (Short Message Service)` template form. | ||
|
|
||
| A/B tests | ||
| ========= | ||
|
|
||
| :guilabel:`A/B Tests` allows any :abbr:`SMS (Short Message Service)` mailings to be tested against | ||
| other versions within the same campaign, in order to compare which version is the most successful in | ||
| producing engagement and/or conversion outcomes. | ||
|
|
||
| On an :abbr:`SMS (Short Message Service)` template form, under the :guilabel:`A/B Tests` tab, | ||
| initially, there's only a single checkbox labeled: :guilabel:`Allow A/B Testing.` | ||
|
|
||
| When clicked, a series of other options appear. | ||
|
|
||
| .. image:: sms_campaign_settings/ab-tests-sms.png | ||
| :align: center | ||
| :alt: The A/B Test tab is located on an Odoo SMS Marketing app campaign form. | ||
|
|
||
| In the first field, enter a desired percentage of recipients to conduct the A/B Test on. | ||
|
|
||
| Beneath the percentage field is the :guilabel:`Winner Selection` field. This is what Odoo will use | ||
| to determine the successful result of an A/B Test. In other words, this tells Odoo how to pick a | ||
| winning A/B test. | ||
|
|
||
| The following sections are available: :guilabel:`Manual`, :guilabel:`Highest Click Rate`, | ||
| :guilabel:`Leads`, :guilabel:`Quotations`, or :guilabel:`Revenues`. | ||
|
|
||
| Finally, the :guilabel:`Send Final On` field is listed. This represents the date-time that Odoo uses | ||
| as a deadline to determine the winning mailing variation. Then, Odoo sends that winning mailing | ||
| variation to the remaining recipients, who weren't involved in the test, at that prior date and | ||
| time. | ||
|
|
||
| .. tip:: | ||
| Quickly create different versions of the mailing to add to the A/B Test by clicking the | ||
| :guilabel:`Create an Alternate Version` button. | ||
|
|
||
| .. note:: | ||
| Remember, the winning mailing variation is based on the criteria selected in the | ||
| :guilabel:`Winner Selection` field. | ||
|
|
||
| Campaigns page | ||
| ============== | ||
|
|
||
| To create, edit, or analyze any campaign, click :menuselection:`Campaigns` in the header menu of the | ||
| :guilabel:`SMS Marketing` app. On the :guilabel:`Campaigns` page, each campaign displays various | ||
| information related to the mailings associated with that campaign (e.g. number of emails, social | ||
| posts, SMSs, and push notifications). | ||
|
|
||
| .. image:: sms_campaign_settings/campaigns-page.png | ||
| :align: center | ||
| :alt: Dasbhoard view of different Campaigns in the Odoo SMS Marketing app, separated by stage. | ||
|
|
||
| Campaign templates | ||
| ================== | ||
|
|
||
| Click :guilabel:`Create` to create a new campaign, and Odoo reveals a blank campaign template form | ||
| to fill out. Alternatively, select any previously-made campaign in order to duplicate, review, or | ||
| edit its campaign template form. | ||
|
|
||
| .. image:: sms_campaign_settings/sms-campaign-template.png | ||
| :align: center | ||
| :alt: View of an SMS campaign template in Odoo SMS marketing. | ||
|
|
||
| With each campaign, the options to :guilabel:`Send New Mailing`, :guilabel:`Send SMS`, | ||
| :guilabel:`Send Social Post`, and :guilabel:`Push Notifications` are available above the template | ||
| form. | ||
|
|
||
| Whenever one of those communication options is added to the campaign, Odoo will create a new | ||
| corresponding tab on the template form, where those types of messages can be reviewed or edited, | ||
| along with various data sets related to each specific mailing. | ||
|
|
||
| At the top of the template, there are various analytical smart buttons. When clicked, Odoo reveals | ||
| in-depth metrics related to that specific topic (e.g. :guilabel:`Engagement`, | ||
| :guilabel:`Opportunities`, etc.) on a separate page. | ||
|
|
||
| Beneath the smart buttons, are fields for :guilabel:`Campaign Name` and :guilabel:`Responsible`. | ||
| Odoo also allows for various :guilabel:`Tags` to be added, as well (if necessary). | ||
|
|
||
| Sending SMSs through the Contacts app | ||
| ===================================== | ||
|
|
||
| Sending :abbr:`SMS (Short Message Service)` mailings directly through a contact's form is available | ||
| by default. | ||
|
|
||
| In order to send an :abbr:`SMS (Short Message Service)` in this fashion, navigate to the | ||
| :menuselection:`Contacts` app, select the desired contact in the database, and click on the | ||
| :guilabel:`SMS` icon on the contact form (next to the :guilabel:`Phone Number` field). | ||
|
|
||
| .. image:: sms_campaign_settings/sms-contact-form.png | ||
| :align: center | ||
| :alt: The SMS icon is located on an individual's contact form in Odoo Contacts. | ||
|
|
||
| To send a message to multiple contacts at once, navigate to the main :menuselection:`Contacts` app | ||
| main dashboard, choose the :guilabel:`List View`, and select all the desired contacts to whom the | ||
| message should be sent. Then, under :guilabel:`Action`, select :guilabel:`Send SMS`. | ||
|
|
||
| .. image:: sms_campaign_settings/sms-contacts-action-send-message.png | ||
| :align: center | ||
| :alt: Select a number of contacts, click action, and select send multiple SMSs. | ||
|
|
||
| Set up SMS templates for future use | ||
| =================================== | ||
|
|
||
| In order to set up :guilabel:`SMS Templates` for future use, activate :ref:`developer mode | ||
| <developer-mode>`, by navigating to the main Odoo dashboard that is full of apps, and select the | ||
| :menuselection:`Settings app`. Then, scroll down to the :guilabel:`Developer Tools` section, and | ||
| click :guilabel:`Activate the Developer Mode`. | ||
|
|
||
| Once *developer mode* is activated, the main Odoo dashboard appears once more, with a now-visible | ||
| bug icon, which is located at the top-right corner of the dashboard; this bug icon indicates that | ||
| developer mode is currently active. | ||
|
|
||
| Next return to the :menuselection:`Settings app` and, in the now-visible header menus at the top, | ||
| choose :menuselection:`Technical --> SMS Templates` to begin setting up :abbr:`SMS (Short Message | ||
| Service)` templates for future marketing campaigns. | ||
|
|
||
| .. image:: sms_campaign_settings/sms-template-setting.png | ||
| :align: center | ||
| :alt: Select the SMS Template option in the Technical dropdown on the Settings app. | ||
|
|
||
| Inside of the :guilabel:`SMS Templates` dashboard, Odoo reveals an entire page of :abbr:`SMS (Short | ||
| Message Service)` templates. The default :guilabel:`List` view showcases each template's name, and | ||
| to which recipients it applies. | ||
|
|
||
| On this page, :abbr:`SMS (Short Message Service)` templates can be edited or created from scratch. | ||
|
|
||
| .. image:: sms_campaign_settings/sms-template.png | ||
| :align: center | ||
| :alt: The SMS Templates page in Odoo is available after enabling developer mode in the General | ||
| Settings |
Binary file added
BIN
+16.8 KB
...tions/marketing/sms_marketing/essentials/sms_campaign_settings/ab-tests-sms.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+17.2 KB
...ons/marketing/sms_marketing/essentials/sms_campaign_settings/campaigns-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+37.8 KB
...keting/sms_marketing/essentials/sms_campaign_settings/sms-campaign-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+16.2 KB
...s/marketing/sms_marketing/essentials/sms_campaign_settings/sms-contact-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+34.7 KB
...marketing/essentials/sms_campaign_settings/sms-contacts-action-send-message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+6.2 KB
...keting/sms_marketing/essentials/sms_campaign_settings/sms-mailing-campaigns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+27.3 KB
...rketing/sms_marketing/essentials/sms_campaign_settings/sms-template-setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+25.6 KB
...tions/marketing/sms_marketing/essentials/sms_campaign_settings/sms-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ksc-odoo @samueljlieber
Think we wanted to remove the pricing FAQ here and just make essentials the top-level directory for SMS, right?
If so, we'll need to follow up in another PR to clean that up, which could be a good opportunity to wipe out all mid-level directories that aren't needed for all US scopes.