Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A python module for using Hoiio REST API.
Python
branch: master

This branch is 1 commit ahead, 2 commits behind mickeyckm:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
hoiio
.gitignore
LICENSE
README.md
setup.py

README.md

Python-Hoiio

A python module for using Hoiio REST API.

Requirements

Installation

Install from PyPi using pip, a package manager for Python.

$ pip install python-hoiio

you can download the source code (ZIP) for python-hoiio, and then run:

$ python setup.py install

You may need to run the above commands with sudo.

Getting Started

Getting started with the Hoiio API couldn't be easier. Create a HoiioRestClient and you're ready to go.

API Credential

The HoiioRestClient needs your Hoiio credentials. You can either pass these directly to the constructor (see the code below) or via environment variables.

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

Make a call

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

resp = client.voice.call(params={ "dest":'+6512345678', "dest2":'+6554326547', "caller_id":'Mickey Cheong' })

Send a sms

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

resp = client.sms.send({ "dest":'+6565123476', "msg":'Hello, Mickey' })

Subcribe a number

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

resp = client.number.subscribe({ number:'+6567589405', duration:60 })

Get account balance

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

resp = client.account.balance()

Dial a number

from hoiio.rest import HoiioRestClient

appid = 'YOUR_APPID_HERE'
token = 'YOUR_TOKEN_HERE'
client = HoiioRestClient(appid, token)

resp = client.ivr.dial(params={ 'dest': '+6599238829', \
                                'msg': '<speech language="en" gender="male">Hello World</speech>' })

License

Copyright (c) Mickey Cheong and individual contributors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of python-hoiio nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Something went wrong with that request. Please try again.