https://github.com/skocimis/textflow-python
Python package that helps you helps send SMS and verify users using TextFlow API
https://github.com/skocimis/textflow-python
api api-client python python-library python-sms python3 simple-sms sms sms-api sms-python sms-python-package sms-verification text-message user-verification
Last synced: 3 months ago
JSON representation
Python package that helps you helps send SMS and verify users using TextFlow API
- Host: GitHub
- URL: https://github.com/skocimis/textflow-python
- Owner: Skocimis
- License: mit
- Created: 2023-01-31T18:14:24.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-05T05:49:58.000Z (over 2 years ago)
- Last Synced: 2025-01-08T18:36:47.557Z (5 months ago)
- Topics: api, api-client, python, python-library, python-sms, python3, simple-sms, sms, sms-api, sms-python, sms-python-package, sms-verification, text-message, user-verification
- Language: Python
- Homepage: https://textflow.me
- Size: 18.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Textflow python client
[](https://pypi.python.org/pypi/textflowsms)
[](https://pypi.python.org/pypi/textflowsms)
### 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](https://textflow.me/api). When you register an account, you automatically get an API key with one free SMS which you can send anywhere.
### Just send a message
```python
import textflowsms as tf
tf.useKey("YOUR_API_KEY");
tf.sendSMS("+381611231234", "Dummy message text...")
```
### Handle send message request result
```python
result = tf.sendSMS("+381611231234", "Dummy message text...")
if(result.ok):
print(result.data)
else:
print(result.message)
```
### Example result object of the successfully sent message
```json
{
"ok": true,
"status": 200,
"message": "Message sent successfully",
"data": {
"to": "+381611231234",
"content": "Dummy message text...",
"country_code": "RS",
"price": 0.05,
"timestamp": 1674759108881
}
}
```
### Example result object of the unsuccessfully sent message
```json
{
"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
```python
# User has sent his phone number for verification
resultSMS = tf.sendVerificationSMS ("+11234567890", 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("+11234567890", 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](https://textflow.me) first, and contact us at [[email protected]](mailto://[email protected]) 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!