Skip to content

Commit 675f4d6

Browse files
fix(docs): sms-broadcast README.md updates
Also includes a link to the Notifiy Service config in sms-broadcast's index.html
1 parent b1d6de7 commit 675f4d6

File tree

2 files changed

+12
-13
lines changed

2 files changed

+12
-13
lines changed

sms-broadcast/README.md

+5-11
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,19 @@ twilio serverless:init example --template=sms-broadcast && cd example
3838

3939
Before using this Function, you will need to create (or use an existing) Notify service and Messaging service. The Notify service will use the Messaging service to send out SMS messages. The Messaging service will be configured to send incoming messages to your Subscribe/Broadcast function.
4040

41-
### Create a Messaging Service
42-
43-
Go to the console and [create a messaging service](https://www.twilio.com/console/sms/services). Choose the "Notifications, Two-way" use case to preset some options on the service.
44-
45-
Once created, click on the left nav link for "Numbers" and add (or buy) a phone number to use with this service. This will be the phone number(s) your end users will interact with.
46-
47-
We'll need to come back here later - consider leaving this page open in a tab while you proceed to the next step in the console.
48-
4941
### Create a Notify Service
5042

5143
In the console, create a [Notify service](https://www.twilio.com/console/notify/services). Our function code uses Notify to store our subscriber list and to send out notifications. After your service is created, locate the Dropdown in your Notify service config labeled "Messaging Service SID". You should be able to choose the Messaging Service we created in the last step.
5244

5345
You will need the generated SID for this service to configure your environment in the next step.
5446

55-
Don't forget to save your changes!
47+
### Create a Messaging Service
48+
49+
Once your [Notify service](https://www.twilio.com/console/notify/services) is created, go to its config page in the console and locate the Dropdown labeled "Messaging Service SID". Click the link next to that Dropdown labeled "Create a Messaging Service here". For the new Messaging Service's use case, choose "Not listed here". When prompted, add the phone number you want to use with this service to the Messaging Service's Sender Pool.
5650

5751
### Deploy the Function template
5852

59-
Add the Notify Service SID to the `.env` file as `BROADCAST_NOTIFY_SERVICE_SID`. Add the phone numbers of admins that are permitted to send broadcast messages to the `.env` file as `BROADCAST_ADMIN_NUMBERS`.
53+
Add the Notify Service SID (which should start with `IS`) to the `.env` file as `BROADCAST_NOTIFY_SERVICE_SID`. Add the phone numbers of admins that are permitted to send broadcast messages to the `.env` file as `BROADCAST_ADMIN_NUMBERS`.
6054

6155
Deploy your functions and assets with the following command. Note: you must run this command from inside your project folder. [More details in the docs.](https://www.twilio.com/docs/labs/serverless-toolkit)
6256

@@ -70,7 +64,7 @@ In a few moments your Function should be deployed! Grab its URL from the results
7064

7165
### Handle incoming messages with your Function
7266

73-
Go back to the [messaging service](https://www.twilio.com/console/sms/services) you created earlier. In its configuration, you'll see a checkbox for "Handle Incoming Messages". Click this box to enable the feature. In the text box that appears, paste in the URL to the Function we just deployed. Click "Save".
67+
Go back to the [messaging service](https://www.twilio.com/console/sms/services) you created earlier. In the sidebar, look for the Integration menu item. Under the Incoming Messages section of the Integration configuration page, you'll see a radio button for "Send a webhook". Click this radio button, and in the "Request URL" textbox that appears, paste the URL to the Function we just deployed. Click "Save".
7468

7569
Now if all went well, you'll be able to start using your phone number for managing broadcasts and subscriptions!
7670

sms-broadcast/assets/index.html

+7-2
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,13 @@ <h2>Get started with your application</h2>
5050
<p>This app allows you to broadcast SMS messages to large numbers of people.</p>
5151
<ol class="steps">
5252
<li>
53-
In the Twilio Console page for your Notify Service, create a new Messaging
54-
Service with use case <b>Not listed here</b>, and add your Twilio phone number
53+
In the Twilio Console page for your Notify Service,
54+
<a href="https://www.twilio.com/console/notify/services"
55+
target="_blank"
56+
rel="noopener">
57+
create a new Messaging Service
58+
</a>
59+
with use case <b>Not listed here</b>, and add your Twilio phone number
5560
to its sender pool
5661
</li>
5762
<li>

0 commit comments

Comments
 (0)