This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuDocs
Close Sidemenu

Secure Applications with Telnyx Two factor authenticationsecure-applications-with-telnyx-two-factor-authentication

20 minutes build time || Difficulty Level: Intermediate || Github RepoTelnyx Developers

Configuration Fileconfiguration-file

Create a config.cfg file in your project directory. Flask will load this at startup. First, use thisTelnyx Developers guide to provision an SMS number and messaging profile, and create an API key. Then add those to the config file.


Note: This file contains a secret key, it should not be committed to source control.

We’ll also place Flask in debug mode, assume all numbers are in the U.S., and specify the number of characters we'd like the OTP token to be.


Token Storagetoken-storage

We'll use a class to store tokens in memory for the purposes of this example. In a production environment, a traditional database would be appropriate. Create a class called TokenStorage with three methods. This class will store uppercase tokens as keys, with details about those tokens as values, and expose check and delete methods.

class TokenStorage():
    tokens = {}

    def add_token(cls, token, phone_number):
        cls.tokens[token] = {
            'phone_number': phone_number,
            'token': token.upper()

    def token_is_valid(cls, token):
        return token.upper() in cls.tokens

    def clear_token(cls, token):
        del TokenStorage.tokens[token.upper()]

Server initializationserver-initialization

Setup a simple Flask app, load the config file, and configure the telnyx library. We'll also serve an index.html page, the full source of this is available on GitHub, but it includes a form that collects a phone number for validation.

app = Flask(__name__)

telnyx.api_key = app.config['API_KEY']

def serve_index():
    return render_template('index.html')

Token generationtoken-generation

We'll start with a simple method, get_random_token_hex, that generates a random string of hex characters to be used as OTP tokens.

def get_random_token_hex(num_chars):
    byte_data = secrets.token_hex(math.ceil(num_chars / 2.0))
    return byte_data.upper()[:num_chars]

The token_hex method accepts a number of bytes, so we need to divide by two and and round up in order to ensure we get enough characters (two characters per byte), and then finally trim by the actual desired length. This allows us to support odd numbered token lengths.

Next, handle the form on the /request route. First this method normalizes the phone number.

@app.route('/request', methods=['POST'])
def handle_request():
    phone_number = (request.form['phone']
                    .replace('-', '').replace('.', '')
                    .replace('(', '').replace(')', '')
                    .replace(' ', ''))

Then generate a token and add the token/phone number pair to the data store.

    generated_token = get_random_token_hex(app.config['TOKEN_LENGTH'])
    TokenStorage.add_token(generated_token, phone_number)

Finally, send an SMS to the device and serve the verification page.

        to=app.config['COUNTRY_CODE'] + phone_number,
        text='Your token is ' + generated_token

    return render_template('verify.html')

Token verificationtoken-verification

The verify.html file includes a form that collects the token and sends it back to the server. If the token is valid, we'll clear it from the datastore and serve the success page.

@app.route('/verify', methods=['POST'])
def handle_verify():
    token = request.form['token']

    if TokenStorage.token_is_valid(token):
        return render_template('verify_success.html')

Otherwise, send the user back to the verify form with an error message

        return render_template('verify.html', display_error=True)

Finishing upfinishing-up

At the end of the file, run the server.

if __name__ == "__main__":

To start the application, run python from within the virtualenv.

Was this page helpful?was-this-page-helpful