Level up your Twilio API skills in TwilioQuest, an educational game for Mac, Windows, and Linux. Download Now

メニュー

Expand
Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Customizing Users’ Opt-in and Opt-out Experience with Advanced Opt-Out

In this tutorial, we will set up global opt-in and opt-out keywords and messages with Messaging Service’s Advanced Opt-Out feature. Configuring these keywords is an effective way to localize the experience for your customers all over the world.

Twilio, by default, handles standard English-language reply messages such as STOP, UNSTOP, UNSUBSCRIBE or CANCEL for Toll-Free and Long Code numbers, in accordance with industry standards. (Please consult our support documentation on Twilio’s support for opt-out keywords for more.) This tutorial covers customizing opt-in/opt-out keywords and messages for a Messaging Service.

If you already have set up your Messaging Service, skip ahead to configuring Advanced Opt-Out keywords.

Global opt-in and opt-out keywords are a feature of Twilio Messaging Services. A Messaging Service is a higher-level “bundling” of messaging functionality around a common set of senders, features, and configuration.

If you haven’t already done so, create a new Messaging Service:

        
        
        
        
        Create a Messaging Service and give it a name

        Messaging Serviceを作成する

        Create a Messaging Service and give it a name

        Copy down the Messaging Service SID (It starts with MGXXX). You'll need it in the next step when you associate a phone number with this Service.

        SMS機能の利用できる電話番号を購入する

        Sending SMS messages requires an SMS capable phone number. You can search for and purchase available phone numbers in the Console. When you search, make sure that the number you choose is SMS capable. Check the appropriate box in the search UI to filter available numbers to those that are SMS capable.

        SMSの利用できる番号を検索する

        検索結果の表示時に、どの番号でSMSが利用できるか確認できます。

        SMSの利用できる番号を購入しましょう。

        ピッカピカの新しいTwilio電話番号で、モバイル機器にSMSを送りはじめることができます。

        Add a Number to Number Pool

        Now, associate your SMS-enabled Twilio number with the Messaging Service that you created. To do this, you will need the Phone Number's unique SID, which starts with PNXXX. You can find this in the Phone Numbers Section of the Twilio Console.

        find_phone_number_sid.png

        Use the Phone Number's SID to attach to the Messaging Service that you created:

              
              
              
              
              Associate a Phone Number with your Messaging Service

              Add Number to Numbers Pool

              Associate a Phone Number with your Messaging Service

              Configuring Advanced Opt-Out keywords

              Now that you have your Messaging Service, locate Advanced Opt-Out in the Features Section. This is where you can configure your Advanced Opt-Out preferences:

              find-advanced-opt-out.png

              Changing the global defaults

              Global defaults apply to any country for which you have not specified an override, which the next section covers. Since you have not added any country overrides yet, all incoming messages are handled according to the global defaults.

              When configuring Advanced Opt-Out, developers should make sure not to include any Personally Identifiable Information (PII) in the response messages to customers.

              Editing opt-out keywords and message

              Some opt-out keywords are non-removable; however, if your use case requires more keywords than Twilio recognizes by default, you can add them here, separated by commas.

              Please note that Twilio tries to match keywords in a case insensitive way. ‘Stop’ will be handled the same way as ‘STOP’ or ’stop’.

              Advanced Opt-Out: Add global opt-out keyword

              When receiving an opt-out keyword from one of your users, Twilio adds a blacklist entry containing their number.

              Twilio checks this blacklist before sending any future outgoing messages. Any subsequent outgoing messages from your account to this user will fail with error code 30004.

              Editing opt-in keywords and message

              You can specify what keywords Twilio will interpret as opt-in keywords. When one of your users sends an opt-in keyword, Twilio removes the blacklist entry containing the user’s number (if it exists) and sends the message you defined to notify the customer that they have opted back in. Any subsequent outgoing messages to this user from your account will not be blocked.

              Advanced Opt-Out: Add global opt-in keyword

              Editing help keywords and message

              With help keywords, you can let your users know who owns a particular number as well as what actions are available. When Twilio receives a help keyword from one of your users, there is no impact on the blacklist. However, if the user has opted out previously, they won't receive your defined help message in response.

              Advanced Opt-Out: Add global help keyword

              Adding additional global defaults

              You can set global defaults in more than one language. If a user texts in using one of your configured keywords, Advanced Opt-Out will match the keyword and return the message that you configured. For example, you can set English and Spanish defaults if you want to localize the user opt-in/opt-out keywords for your global Spanish-speaking users, rather than setting country-specific Spanish overrides for every Spanish-speaking country.

              Advanced Opt-Out: Add second global default

              Adding a Country Override with two languages

              If you have users in a country where you would like to provide a localized experience, you can easily do that by creating a country override. Please note: a Country Override replaces the Global Defaults for a specific country. Be sure to add all keywords and responses that you wish to support for this country.

              Note: When specifying Country Overrides, you must select at least one language to add keywords. If you wish to localize the behavior further, you can add another language.

              Advanced Opt-Out: Add country override with two languages

              When receiving an incoming message from one of your users, Twilio matches the country code of your user’s phone number with the configuration that you specified. It then attempts to match one of the keywords listed in the pre-defined languages. If there is a match, Twilio applies any necessary blacklist action then replies with the message in the language of your user's keyword.

              Therefore, all keywords in a country, across all languages, need to be unique.

              Please note: It is up to the developer to handle localization of keywords for Country Overrides. Twilio does not perform translation; it will only handle the literal keywords as specified in the Country Override.

              Be aware: the same keyword cannot be entered in two different languages for the same country. If a word is entered in one language, the same keyword won't be accepted in another language.

              Keeping Track of your User's Status

              With Advanced Opt-Out, you can keep track of the most up-to-date information about your users' opt-in and opt-out preferences. When an incoming message triggers one of your opt-out keywords, Twilio includes an OptOutType property in the request object sent to the webhook URL configured for your Messaging Service. The value is START, STOP, or HELP, depending on the incoming keyword.

              関連トピック

              You’ve now successfully added global keywords to your Messaging Service by configuring the Advanced Opt-Out feature.

              Check out these other Messaging Service Resources to improve your users' experience:

              Rate this page:

              ヘルプが必要ですか?

              誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。