Skip to content
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

Add Twilio docs #260

Merged
merged 4 commits into from
Apr 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/plugins/images/twilio-sid-authtoken.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 docs/plugins/images/twilio-webhook-callback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 56 additions & 19 deletions docs/plugins/twilio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,56 @@

In order to configure the text messages correctly, follow these steps:

#. Create an account at :xref:`Twilio`.
1. Create an account at :xref:`Twilio`.

#. In Mautic, go to *Settings* (cog icon) > *Plugins*.
2. In Mautic, go to *Settings* (cog icon) > *Plugins*.

Check warning on line 19 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 19, "column": 32}}}, "severity": "INFO"}

#. Open *Twilio* Plugin and activate it.
3. Open *Twilio* Plugin and activate it.

#. Copy the *Account Sender ID* from Twilio account and paste it to *Account Sender ID* field in the Twilio Plugin configuration.
4. Log into your Twilio account and go to *Dashboard*.

#. Unlock and copy the *Auth Token* and paste it to *Auth Token* field in the Twilio Plugin configuration.
.. image:: images/twilio-sid-authtoken.png
:width: 400
:alt: Screenshot of the SID and Auth Token fields

Check warning on line 27 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'SID', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'SID', if it's unfamiliar to the audience.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 27, "column": 29}}}, "severity": "INFO"}


5. Copy the *Account Sender ID (SID)* from Twilio account and paste it to *Account Sender ID* field in the Twilio Plugin configuration.

Check warning on line 30 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 30, "column": 32}}}, "severity": "INFO"}

6. Unlock and copy the *Auth Token* and paste it to *Auth Token* field in the Twilio Plugin configuration.

7. Go to *Phone Numbers* > Active numbers in Twilio, add a phone number if you haven't already commissioned one.

8. Go to *Messaging* > *Services* in Twilio, and create a new Messaging Service. Select the appropriate settings from the dropdown in the first step as relevant to your usage of SMS messages with Mautic, then click 'Create Messaging Service' at the bottom right.

.. image:: images/twilio-messaging-services.png
:width: 400
:alt: Screenshot of the Messaging Services interface

9. Click the button to add your phone number as a Sender for this Messaging Service, then select the box and click 'Set up Integration' at the bottom right to move on to the next step.

10. Select 'Send a Webhook' under the Integration settings.

11. Configure the Request URL and Fallback URL to use the callback URL of ``https://example.com/sms/twilio/callback`` where ``example.com`` is your Mautic instance domain. Also enter this in the 'Delivery Status Callback' field.

#. Go to *Products* > *Phone Numbers* in Twilio, copy the number and paste it to the *Sending Phone Number* field in Mautic.
.. image:: images/twilio-webhook-callback.png
:width: 400
:alt: Screenshot of the Messaging Services interface

12. Click the 'Add Compliance Info' button to proceed to the next step, where you can register to send Application to Person (A2P) messages using a 10 digit long code phone number. Otherwise, click the button in the bottom right to complete setup. Click on 'View my new Messaging Service' to see the details of the service you just created. Once created you can view the SID from the Messaging > Services screen.

Check warning on line 52 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 52, "column": 126}}}, "severity": "INFO"}

Check warning on line 52 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.FirstPerson] Avoid first-person pronouns such as 'my'. Raw Output: {"message": "[Google.FirstPerson] Avoid first-person pronouns such as 'my'.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 52, "column": 264}}}, "severity": "WARNING"}

Check warning on line 52 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Acronyms] Spell out 'SID', if it's unfamiliar to the audience. Raw Output: {"message": "[Google.Acronyms] Spell out 'SID', if it's unfamiliar to the audience.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 52, "column": 372}}}, "severity": "INFO"}

.. image:: images/twilio-messaging-service-id.png
:width: 400
:alt: Screenshot of the Messaging Services ID field on Twilio.

13. Copy the Messaging Service ID and paste this into the 'Features' tab of your Mautic Twilio Plugin settings

#. Select the *Text Message Enabled*? switch to *Yes* and save the Mautic configuration.
.. image:: images/twilio-messaging-service-id-mautic.png
:width: 400
:alt: Screenshot of the Messaging Services ID field in Mautic.

14. Configure the global frequency rules for the SMS Channel as appropriate for your business.

15. Select the *Published*? switch to *Yes* in the Enabled/Auth tab in Mautic and save the Plugin configuration.

.. vale off

Expand All @@ -35,9 +72,9 @@

.. vale on

Alphanumeric Sender ID allows you to send Twilio Programmable SMS messages using a personalized sender name, in supported countries see :xref:`International Support for Alphanumeric Sender ID`.
Alphanumeric Sender ID allows you to send SMS messages using a personalized sender name, in supported countries see :xref:`International Support for Alphanumeric Sender ID`.

Instead of using an E.164 formatted Twilio Phone number for the "From" value, you can use a custom string like your own business' branding.
Instead of using an E.164 formatted Twilio Phone number for the 'From' value, you can use a custom string like your own business' branding.

.. note::

Expand All @@ -56,25 +93,25 @@

#. Login to your account at :xref:`Twilio`.

#. From the left side navigation bar, click Programmable SMS.
#. From the left side navigation bar, click Messaging > Overview.

#. Click Settings.

#. Verify that you have ``Alphanumeric Sender ID``.
#. From the General Messaging Settings page, Verify the 'Alphanumeric Sender ID' setting.

Check warning on line 100 in docs/plugins/twilio.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'. Raw Output: {"message": "[Mautic.FeatureList] Is this referring to a Mautic feature? If so, use 'Landing Page' instead of 'page'.", "location": {"path": "docs/plugins/twilio.rst", "range": {"start": {"line": 100, "column": 40}}}, "severity": "INFO"}

Follow these steps to see if your account has Alphanumeric Sender enabled.
.. image:: images/twilio-alpha-numeric-number-settings.png
:width: 400
:alt: Screenshot of the Alphanumeric settings on Twilio.

.. vale off

Send SMS Messages using an Alphanumeric Sender ID with Mautic
*************************************************************
Adding alphanumeric sender ID to a Messaging Service
====================================================

.. vale on
#. Open your Messaging Service via your Twilio Dashboard

Just set up your alias in Plugin settings:
#. Under the **Senders** section, click the **Add Senders IDs** button

.. image:: images/alphanumeric-id.png
:width: 400
:alt: Screenshot of alphanumeric-id
#. From the **Add Senders IDs** dropdown, select **Alpha Sender** and enter the alphanumeric sender ID that you want to add to the Sender Pool.

Read more info about :xref:`Alphanumeric Sender ID` on Twilio site.
Loading