Python SDK for Direct7 Platform REST API
Project description
Direct7 Python SDK
Python SDK to seamlessly incorporate communication features into your Python applications via the Direct7 REST API. This SDK empowers you to effortlessly initiate SMS,Whatsapp, Slack, Viber messages and 2 factor authentication features.
Documentation
The documentation for the Direct7 REST API can be found here Direct7 API Reference.
Installation
The SDK is available on PyPI and can be installed using pip:
pip install direct7
Usage
To get started you need to have an active Direct7 account, If you haven't yet registered, please proceed to Sign up
Authentication
In order to initiate API requests, create a client object using your Direct7 API token. To obtain an API token, kindly visit the following link: https://app.d7networks.com/api-tokens.
Examples
SMS
Send SMS
from direct7 import Client
client = Client(api_token="Your API token")
client.sms.send_messages(
{"recipients": ["+9199XXXXXXXX"], "content": "Greetings from D7 API", "unicode": False},
originator="Sender",
report_url="https://the_url_to_receive_delivery_report.com",
schedule_time='2024-02-05T09:48:42+0000',
)
Send an Unicode SMS
from direct7 import Client
client = Client(api_token="Your API token")
client.sms.send_messages(
{"recipients": ["+9199XXXXXXXXXX"],"content": "مرحبا بالعالم!", "unicode": True},
originator="Sender",
report_url="https://the_url_to_receive_delivery_report.com",
)
Check SMS Request Status
from direct7 import Client
client = Client(api_token="Your API token")
# request_id is the id returned in the response of send_message
client.sms.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Verify
Send OTP
from direct7 import Client
client = Client(api_token="Your API token")
client.verify.send_otp(originator="SignOTP", recipient="+97150900XXXX", content = "Greetings from D7 API, your mobile verification code is: {}", expiry = 600, data_coding = "text")
Re-Send OTP
from direct7 import Client
client = Client(api_token="Your API token")
client.verify.resend_otp(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Verify OTP
from direct7 import Client
client = Client(api_token="Your API token")
client.verify.verify_otp(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1", otp_code="1425")
Check Verify Request Status
from direct7 import Client
client = Client(api_token="Your API token")
# otp_id is the id returned in the response of send_otp
client.verify.get_status(otp_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Send Whatsapp Free-form Message (Contact Details)
from direct7 import Client
client = Client(api_token="Your API token")
client.whatsapp.send_whatsapp_freeform_message(originator="91906152XXXX", recipient="91906152XXXX", message_type="CONTACTS", first_name="Amal", last_name="Anu", display_name="Amal Anu", phone="91906152XXXX", email = "amal@gmail.com")
Send Whatsapp Templated Message.
from direct7 import Client
client = Client(api_token="Your API token")
client.whatsapp.send_whatsapp_templated_message(originator="91906152XXXX", recipient="91906152XXXX", message_type="TEMPLATE", template_id="monthly_promotion", body_parameter_values={"0": "promotion"})
Check Whatsapp Request Status
from direct7 import Client
client = Client(api_token="Your API token")
# request_id is the id returned in the response of send_message
client.whatsapp.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Number Lookup
Search Phone Number Details
from direct7 import Client
client = Client(api_token="Your API token")
client.number_lookup.search_number_details(recipient="+914257845XXXX")
Viber
Send Viber Message
from direct7 import Client
client = Client(api_token="Your API token")
client.viber.send_viber_message(recipients=["+97150900XXXX","+97845900XXX"], content="Greetings from D7 API", label="PROMOTION", originator="INFO2WAY", call_back_url="https://the_url_to_recieve_delivery_report.com")
Check Viber Request Status
from direct7 import Client
client = Client(api_token="Your API token")
# request_id is the id returned in the response of send_viber_message
client.viber.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
Slack
Send Slack Message
from direct7 import Client
client = Client(api_token="Your API token")
client.slack.send_slack_message(content="Greetings from D7 API", work_space_name="WorkspaceName", channel_name="ChannelName", report_url="https://the_url_to_recieve_delivery_report.com")
Check Slack Request Status
from direct7 import Client
client = Client(api_token="Your API token")
# request_id is the id returned in the response of send_slack_message
client.slack.get_status(request_id="0012c7f5-2ba5-49db-8901-4ee9be6dc8d1")
FAQ
How do I get my API token?
You can get your API token from the Direct7 dashboard. If you don't have an account yet, you can create one for free.
Supported Python versions
The SDK supports Python 3.6 and higher.
Supported APIs
As of now, the SDK supports the following APIs:
| API | Supported? |
|---|---|
| SMS API | ✅ |
| Verify API | ✅ |
| Whatsapp API | ✅ |
| Number Lookup API | ✅ |
| Viber API | ✅ |
| Slack API | ✅ |
How do I get started?
You can find the platform documentation @ Direct7 Docs.
How do I get help?
If you need help using the SDK, you can create an issue on GitHub or email to support@d7networks.com
Contributing
We welcome contributions to the Direct7 Python SDK. If you have any ideas for improvements or bug fixes, please feel free to create an issue on GitHub.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
