Note:
Before you can get started, you need the following already set up:
Set all SMS API configuration settings.
- Python and a familiarity with how to create a new file.
- Poetry for dependency management.
- PIP (package installer for Python) and a familiarity with how to install Python modules.
Learn how to quickly send SMS messages in a Python application with the Sinch SMS API.
To quickly get started setting up a simple client application using the Python SDK:
- If you haven't already, clone the sinch-sdk-python repository.
- Navigate to the
examples/snippetsfolder. - Copy the example
.envfile by running the following command:
cp .env.example .env- Open the
.envfile you just created. Using the access key credentials from your Sinch Build Dashboard, populate the following fields with your values:
| Field | Description |
|---|---|
| SINCH_PROJECT_ID | The unique ID of your Project. |
| SINCH_KEY_ID | The unique ID of your access key. |
| SINCH_KEY_SECRET | The secret that goes with your access key. Note: For security reasons, this secret is only visible right after access key creation. |
Save the file.
The Python SDK uses Poetry to manage packages and dependencies, so install those dependencies using the following command:
poetry install- Navigate to
examples/snippets/sms/batches/send_sms/and open thesnippet.pyfile.
snippet.py
"""
Sinch Python Snippet
This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
"""
import os
from dotenv import load_dotenv
from sinch import SinchClient
load_dotenv()
sinch_client = SinchClient(
project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
sms_region=os.environ.get("SINCH_SMS_REGION") or "MY_SMS_REGION"
)
response = sinch_client.sms.batches.send_sms(
to=["+1234567890"],
from_="+2345678901",
body="Hello, this is a test message!"
)
print(f"Batch sent:\n{response}")
This code initializes the Sinch Client and then sends a message using the batches class.
- Assign your values to the following parameters:
| Parameter | Your value |
|---|---|
from_ | Any number you've assigned to your Sinch account. Find the number on your Customer Dashboard by clicking the service plan ID link and scrolling to the bottom of the page. |
to | The phone number to which you want to send the test SMS message. |
- Save the file.
Now you can execute the code and send your test SMS message. Navigate to examples/snippets/sms/batches/send_sms/ and run the following command:
python snippet.pyThe code you used in the snippet.py file uses the Sinch SDK batches endpoint to send the SMS message.
- Visit our API specification to test more endpoints.