textflowsms 0.1.0

Python library that helps you send SMS using TextFlow API

Textflow python client

Supported Python Versions

This library supports the following Python implementations:

• Python 3.6
• Python 3.7
• Python 3.8
• Python 3.9
• Python 3.10
• Python 3.11

Installation

pip install textflowsms

Sending an SMS

To send an SMS, you have to create an API key using the Textflow dashboard. When you register an account, you automatically get an API key with one free SMS which you can send anywhere.

Just send a message

import textflowsms as tf
tf.useKey("YOUR_API_KEY");

tf.sendSMS("[phone]", "Dummy message text...")

Handle send message request result

result = tf.sendSMS("[phone]", "Dummy message text...")
if(result.ok):
  print(result.data)
else:
  print(result.message)

Example result object of the successfully sent message

{
    "ok": true,
    "status": 200,
    "message": "Message sent successfully",
    "data": {
        "to": "[phone]",
        "content": "Dummy message text...",
        "country_code": "RS",
        "price": 0.05,
        "timestamp": 1674759108881
    }
}

Example result object of the unsuccessfully sent message

{
    "ok": false,
    "status": 404,
    "message": "API key not found"
}

Verifying a phone number

You can also use our service to easily verify a phone number, without storing data about the phones that you are about to verify, because we can do it for you.

Example usage

# User has sent his phone number for verification
resultSMS = tf.sendVerificationSMS ("[phone]", service_name, seconds);

# Show him the code submission form
# We will handle the verification code ourselves

# The user has submitted the code
resultCode = tf.VerifyCode("[phone]", user_entered_code);
# if `resultCode.valid` is True, then the phone number is verified. 

Verification options

service_name is what the user will see in the verification message, e. g. "Your verification code for Guest is: CODE"

seconds is how many seconds the code is valid. Default is 10 minutes. Maximum is one day.

Getting help

If you need help installing or using the library, please check the FAQ first, and contact us at [e-mail] if you don't find an answer to your question.

If you've found a bug in the API, package or would like new features added, you are also free to contact us!