All URIs are relative to https://api.brevo.com/v3
| Method | HTTP request | Description |
|---|---|---|
| get_sms_events | GET /transactionalSMS/statistics/events | Get all your SMS activity (unaggregated events) |
| get_transac_aggregated_sms_report | GET /transactionalSMS/statistics/aggregatedReport | Get your SMS activity aggregated over a period of time |
| get_transac_sms_report | GET /transactionalSMS/statistics/reports | Get your SMS activity aggregated per day |
| send_transac_sms | POST /transactionalSMS/sms | Send SMS message to a mobile number |
GetSmsEventReport get_sms_events(limit=limit, start_date=start_date, end_date=end_date, offset=offset, days=days, phone_number=phone_number, event=event, tags=tags, sort=sort)
Get all your SMS activity (unaggregated events)
from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint
# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'
# create an instance of the API class
api_instance = brevo_python.TransactionalSMSApi(brevo_python.ApiClient(configuration))
limit = 50 # int | Number of documents per page (optional) (default to 50)
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
offset = 0 # int | Index of the first document of the page (optional) (default to 0)
days = 789 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
phone_number = 'phone_number_example' # str | Filter the report for a specific phone number (optional)
event = 'event_example' # str | Filter the report for specific events (optional)
tags = 'tags_example' # str | Filter the report for specific tags passed as a serialized urlencoded array (optional)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)
try:
# Get all your SMS activity (unaggregated events)
api_response = api_instance.get_sms_events(limit=limit, start_date=start_date, end_date=end_date, offset=offset, days=days, phone_number=phone_number, event=event, tags=tags, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionalSMSApi->get_sms_events: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| limit | int | Number of documents per page | [optional] [default to 50] |
| start_date | str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] |
| end_date | str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] |
| offset | int | Index of the first document of the page | [optional] [default to 0] |
| days | int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] |
| phone_number | str | Filter the report for a specific phone number | [optional] |
| event | str | Filter the report for specific events | [optional] |
| tags | str | Filter the report for specific tags passed as a serialized urlencoded array | [optional] |
| sort | str | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [optional] [default to desc] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTransacAggregatedSmsReport get_transac_aggregated_sms_report(start_date=start_date, end_date=end_date, days=days, tag=tag)
Get your SMS activity aggregated over a period of time
from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint
# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'
# create an instance of the API class
api_instance = brevo_python.TransactionalSMSApi(brevo_python.ApiClient(configuration))
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
days = 789 # int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
tag = 'tag_example' # str | Filter on a tag (optional)
try:
# Get your SMS activity aggregated over a period of time
api_response = api_instance.get_transac_aggregated_sms_report(start_date=start_date, end_date=end_date, days=days, tag=tag)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionalSMSApi->get_transac_aggregated_sms_report: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| start_date | str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] |
| end_date | str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] |
| days | int | Number of days in the past including today (positive integer). Not compatible with startDate and endDate | [optional] |
| tag | str | Filter on a tag | [optional] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetTransacSmsReport get_transac_sms_report(start_date=start_date, end_date=end_date, days=days, tag=tag, sort=sort)
Get your SMS activity aggregated per day
from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint
# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'
# create an instance of the API class
api_instance = brevo_python.TransactionalSMSApi(brevo_python.ApiClient(configuration))
start_date = 'start_date_example' # str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
end_date = 'end_date_example' # str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
days = 789 # int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
tag = 'tag_example' # str | Filter on a tag (optional)
sort = 'desc' # str | Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional) (default to desc)
try:
# Get your SMS activity aggregated per day
api_response = api_instance.get_transac_sms_report(start_date=start_date, end_date=end_date, days=days, tag=tag, sort=sort)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionalSMSApi->get_transac_sms_report: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| start_date | str | Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report | [optional] |
| end_date | str | Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report | [optional] |
| days | int | Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' | [optional] |
| tag | str | Filter on a tag | [optional] |
| sort | str | Sort the results in the ascending/descending order of record creation. Default order is descending if `sort` is not passed | [optional] [default to desc] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SendSms send_transac_sms(send_transac_sms)
Send SMS message to a mobile number
from __future__ import print_function
import time
import brevo_python
from brevo_python.rest import ApiException
from pprint import pprint
# Configure API key authorization: api-key
configuration = brevo_python.Configuration()
configuration.api_key['api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api-key'] = 'Bearer'
# Configure API key authorization: partner-key
configuration = brevo_python.Configuration()
configuration.api_key['partner-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['partner-key'] = 'Bearer'
# create an instance of the API class
api_instance = brevo_python.TransactionalSMSApi(brevo_python.ApiClient(configuration))
send_transac_sms = brevo_python.SendTransacSms() # SendTransacSms | Values to send a transactional SMS
try:
# Send SMS message to a mobile number
api_response = api_instance.send_transac_sms(send_transac_sms)
pprint(api_response)
except ApiException as e:
print("Exception when calling TransactionalSMSApi->send_transac_sms: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| send_transac_sms | SendTransacSms | Values to send a transactional SMS |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]