MessageBird's REST API
Project description
MessageBird's REST API for Python
This repository contains the open source Python client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/.
Requirements
- Sign up for a free MessageBird account
- Create a new access key in the developers sections
- An application written in Python >3.8
Installation
The easiest way to install the messagebird package is either via pip:
$ pip install messagebird
or manually by downloading the source and run the setup.py script:
$ python setup.py install
Examples
We have put some self-explanatory examples in the examples directory, but here is a quick example on how to get started. Assuming the installation was successful, you can import the messagebird package like this:
import messagebird
Then, create an instance of messagebird.Client:
client = messagebird.Client('YOUR_ACCESS_KEY')
Now you can query the API for information or send a request. For example, if we want to request our balance information you'd do something like this:
try:
# Fetch the Balance object.
balance = client.balance()
# Print the object information.
print('Your balance:\n')
print(' amount : %d' % balance.amount)
print(' type : %s' % balance.type)
print(' payment : %s\n' % balance.payment)
except messagebird.client.ErrorException as e:
print('Error:\n')
for error in e.errors:
print(' code : %d' % error.code)
print(' description : %s' % error.description)
print(' parameter : %s\n' % error.parameter)
This will give you something like:
$ python example.py
Your balance:
amount : 9
type : credits
payment : prepaid
Please see the other examples for a complete overview of all the available API calls.
To run examples with arguments, try:
$ python ./examples/voice_create_webhook.py --accessKey accessKeyWhichNotExist --url https://example.com --title HELLO_WEBHOOK --token HELLO_TOKEN
Documentation
Complete documentation, instructions, and examples are available at: https://developers.messagebird.com/.
License
The MessageBird REST Client for Python is licensed under The BSD 2-Clause License. Copyright (c) 2022, MessageBird
Project details
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.
Source Distribution
Built Distribution
File details
Details for the file messagebird-2.2.0.tar.gz
.
File metadata
- Download URL: messagebird-2.2.0.tar.gz
- Upload date:
- Size: 30.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71e80425f6027630b4c66d40c70f75ef8516c9d942e1b003f7d488c69e23ad79 |
|
MD5 | 88500fd04d0af1eef48c3b6cdfc63345 |
|
BLAKE2b-256 | 5061c544af7fb0a61f83ca3cf0ec3933748a433cfec4e2ad65b4c57e1ee980e3 |
File details
Details for the file messagebird-2.2.0-py2.py3-none-any.whl
.
File metadata
- Download URL: messagebird-2.2.0-py2.py3-none-any.whl
- Upload date:
- Size: 28.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c92ce85044ad6c5c1d012129b32557767e1709492b8d4c93be037fed1b8e9db0 |
|
MD5 | 81dc193dee9153dbb6f47f004687c1ce |
|
BLAKE2b-256 | d1e9b41933644cdecd69f488bb98a9c7ed33267274d68642cbf08b4fb96415a6 |