Flask-Twilio Documentation

Transcription

1 Flask-Twilio Documentation Release Leo Singer Mar 02, 2018

2

3 Contents 1 Flask-Twilio Installation 1 2 Set Up 3 3 Making a Call 5 4 Sending a Text Message 7 5 Full Example Flask Application 9 6 Configuration Variables 11 7 API 13 Python Module Index 15 i

4 ii

5 CHAPTER 1 Flask-Twilio Installation Install the extension by running pip: $ pip install Flask-Twilio 1

6 Flask-Twilio Documentation, Release Chapter 1. Flask-Twilio Installation

7 CHAPTER 2 Set Up Flask-Twilio can be initialized by first creating the application and then creating the flask_twilio.twilio instance: from flask import Flask from flask_twilio import Twilio app = Flask( name ) twilio = Twilio(app) or using the factory method approach, creating the application first, then the flask_twilio.twilio instance, and finally calling flask_twilio.twilio.init_app(): twilio = Twilio() app = Flask( name ) twilio.init_app(app) 3

8 Flask-Twilio Documentation, Release Chapter 2. Set Up

9 CHAPTER 3 Making a Call Making a call involves two steps: first, creating a call view, and second, placing a call. The view produces an XML file that serves as a script for Twilio to follow. Here is an example call view: from flask_twilio import Response from twilio.twiml.messaging_response import Message from twilio.twiml.voice_response def call(): resp = Response() resp.append(say('this is a voice call from Twilio!', voice='female')) resp.append(message('this is an SMS message from Twilio!')) return resp The flask_twilio.twilio.twiml decorator adds some validation and must come after the app.route decorator. To place a call using this view, we use the flask_twilio.twilio.call_for() method, which is based on flask.url_for(): twilio.call_for('call', to=' ') 5

10 Flask-Twilio Documentation, Release Chapter 3. Making a Call

11 CHAPTER 4 Sending a Text Message The above example simultaneously places a voice call and sends a text message. If you only want to send a text message, there is a shortcut: twilio.message('this is an SMS message from Twilio!', to=' ') 7

12 Flask-Twilio Documentation, Release Chapter 4. Sending a Text Message

13 CHAPTER 5 Full Example Flask Application See example.py on GitHub for a full example Flask application. 9

14 Flask-Twilio Documentation, Release Chapter 5. Full Example Flask Application

15 CHAPTER 6 Configuration Variables Flask-Twilio understands the following configuration values: TWILIO_ACCOUNT_SID Your Twilio account SID. TWILIO_AUTH_SID The SID that you use to authenticate with Twilio, if different from your account SID (for example, if you are using an API key). TWILIO_AUTH_TOKEN Your Twilio authentication token. TWILIO_FROM Your default from phone number (optional). Note that there are some useful dummy numbers for testing. SECRET_KEY Same as the standard Flask coniguration value. If provided, then Flask-Twilio will perform some sanity checking to ensure that requests from Twilio result from calls placed by this application. 11

16 Flask-Twilio Documentation, Release Chapter 6. Configuration Variables

17 CHAPTER 7 API class flask_twilio.response(*args, **kwargs) A response class for constructing TwiML documents, providing all of the verbs that are available through twilio.twiml.response. See also class flask_twilio.twilio(app=none) This class is used to control Twilio calls. call_for(endpoint, to, **values) Initiate a Twilio call. Parameters endpoint (str) The view endpoint, as would be passed to flask.url_for(). to (str) The destination phone number. values (dict) Additional keyword arguments to pass to flask.url_for(). Returns call An object representing the call in progress. Return type twilio.rest.resources.call client An application-specific intance of twilio.rest.client. Primarily for internal use. init_app(app) Factory method. message(body, to, **values) Send an SMS message with Twilio. Parameters body (str) The body of the text message. to (str) The destination phone number. values (dict) Additional keyword arguments to pass to twilio.rest. resources.smsmessages.create(). 13

18 Flask-Twilio Documentation, Release Returns message An object representing the message that was sent. Return type twilio.rest.resources.smsmessage signer An application-specific instance of itsdangerous.timestampsigner, or None if no secret key is set. Primarily for internal use. twiml(view_func) Decorator for marking view that will create TwiML documents. validator An application-specific instance of twilio.request_validator.requestvalidator. Primarily for internal use. 14 Chapter 7. API

19 Python Module Index f flask_twilio, 13 15

20 Flask-Twilio Documentation, Release Python Module Index

21 Index C call_for() (flask_twilio.twilio method), 13 client (flask_twilio.twilio attribute), 13 F flask_twilio (module), 13 I init_app() (flask_twilio.twilio method), 13 M message() (flask_twilio.twilio method), 13 R Response (class in flask_twilio), 13 S signer (flask_twilio.twilio attribute), 14 T Twilio (class in flask_twilio), 13 twiml() (flask_twilio.twilio method), 14 V validator (flask_twilio.twilio attribute), 14 17