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 (tested with Python 2.7 and Python 3.4)
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('test_gshuPaZoeEG6ovbc8M79w0QyM')
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
Conversations WhatsApp Sandbox
To use the whatsapp sandbox you need to add messagebird.Feature.ENABLE_CONVERSATIONS_API_WHATSAPP_SANDBOX
to the list of features you want enabled. Don't forget to replace YOUR_ACCESS_KEY
with your actual access key.
client = messagebird.Client('1ekjMs368KTRlP0z6zfG9P70z', features=[messagebird.Feature.ENABLE_CONVERSATIONS_API_WHATSAPP_SANDBOX])
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) 2014, 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
Hashes for messagebird-1.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f8c87ad77c9cfd92e4c167e63ec0ac31a22756e7ca980ea08b43e1c1be0cf88 |
|
MD5 | 4891f59ded2ef59e3d2b1f5251e01b8e |
|
BLAKE2b-256 | 5a16a2c5edabcc3ea874fd456475e8816f2333f41fcfbc088f0660040075ad81 |