Axik / python-bandwidth

Public API for interfacing with Catapult application from Python

Bandwidth Python API

Bandwidth SDK is Python library for working with Bandwidth platform API. It should be integrated in your python web application easily.

Complete original documentation of API here

Getting started

You need to have

- Git
- Python (2.7, 3.3, 3.4)
- Bandwidth Application Platform account
- pip

Installation

Simply use the following command to install the latest released version:

pip install bandwidth_sdk

If you want the cutting edge version (that may be broken), use this:

pip install -e git+https://github.com/bandwidthcom/python-bandwidth.git#egg=bandwidth_sdk

Note: This may have to be run as root or with --user flag if you are not using python virtual environment.

Usage

• Set up
• Allocating a phone number
• Calls basic usage
• Uploading media
• Sending text message
• Getting number info

The SDK setup

Default setup from environment variables in UNIX shell :

export BANDWIDTH_USER_ID=u-your-user-id
export BANDWIDTH_API_TOKEN=t-your-token
export BANDWIDTH_API_SECRET=s-your-secret

Or explicitly set up in code:

from bandwidth_sdk import Client
Client('u-user', 't-token', 's-secret')

Or using the config file .bndsdkrc that by default is getting from existing path or you can set up path to file using environment variable BANDWIDTH_CONFIG_FILE:

[catapult]
user_id = u-your-user-id
token = t-your-token
secret = s-your-secret

Allocate phone number basic

Import PhoneNumber from sdk

from bandwidth_sdk import PhoneNumber

Get available number for yours search criteria (by location in the following example):

available_numbers = PhoneNumber.list_local(city='Cary', state='NC')
available_numbers[0].allocate()
>>> PhoneNumber(number=[phone])

Search and allocate tool free numbers:

available_numbers = PhoneNumber.list_tollfree(pattern='1844*')
available_numbers[0].allocate()
>>> PhoneNumber(number=[phone])

Get a list of allocated phone numbers:

PhoneNumber.list()
>>> [PhoneNumber(number=[phone]), PhoneNumber(number=[phone])]

Example of iteration over all of allocated numbers:

fallback_number = '[phone]'

for p in PhoneNumber.as_iterator():
	p.patch(fallback_number=fallback_number)

In the example, here we update the fallback_number attribute for all of allocated numbers.

You can also create Application before (or update current), to use your endpoint to handle events related to this Phonenumber.

from bandwidth_sdk import Application
application = Application.create(name='new-application',
                                 incoming_call_url='http://test.callback.info')
# getting number that we allocated before
number = PhoneNumber.get_number_info(number=[phone])
number.patch(application=application)

Now this number is attached to your application, and all events will deliver to incoming_call_url that your point in Application.

###Calls basic usage

Import Call from sdk

from bandwidth_sdk import Call

Creating a new call:

call = Call.create("[phone]", "[phone]")
>>> Call(c-xxxxx, state=started)

Speaking a sentence in a phone call:

call.speak_sentence("Hello", gender="female")

Transferring a call and saying something before bridging the calls:

call.transfer('[phone]', whisper_audio={"sentence": "Hello {number}, thanks for calling"})
>>> Call(c-yyyyy, state=started)

Retrieving list of calls:

Call.list()
>>> [Call(c-xxxx, state=completed), Call(c-yyyyy, state=comleted), Call(c-zzzz, state=started)]

###Uploading the media Make sure that you have media file. In this example we will use test file "dolphin.mp3", that exists in this repo:

from bandwidth_sdk import Media
Media.upload('dolphin.mp3', file_path='./tests/fixtures/dolphin.mp3')
>>> Media(dolphin.mp3)

###Sending text message

Import Message from sdk:

from bandwidth_sdk import Message

Send message by method "send":

Message.send(sender='[phone]',receiver='[phone]', text='Good morning, this is a test message', tag='test tag')
>>> Message('m-id123213', state='sending')

###Getting number info

Import NumberInfo from sdk:

from bandwidth_sdk import NumberInfo

Get number info by CNAM of the number:

NumberInfo.get('[phone]')
>>>NumberInfo(HIGHTSTOWN  NJ)
n_info = _
n_info.updated
>>>datetime.datetime(2014, 12, 19, 2, 14, 14, tzinfo=tzutc())

####More examples:

Take a look of python bandwidth examples repository.

Running tests

make req
make test

or

make req
make test_local

Contribution guidelines

Create a topic branch. Fix the issue. Cover with tests. Add documentation. Send pull request with a comment.