Skip to main content

Modern Python client library for the Sipsentric (Simwood Partner, formerly Nimvelo) API

Project description

Simwood Partner Python Client

A modern Python client library for Sipcentric (Simwood Partner, formerly Nimvelo) API.

from sipcentric import Sipcentric
api = Sipcentric(username="myusername", password="mypassword")
print api.sms.post(_from="0123", to="03301201200", body="Hello World!")

Install

Best method

sudo pip install sipcentric

You may need to install simplejson if you don't have it already.

Manual method

git clone git@github.com:faelix/sipcentric.git && cd sipcentric
sudo python setup.py install

Getting started

Examples

Get account details

from sipcentric import Sipcentric

api = Sipcentric(username="myusername", password="mypassword")

print api.account.get()

Connect to the streaming api

from sipcentric import Sipcentric

api = Sipcentric(username="myusername", password="mypassword")
stream = api.Stream

def callHandler(call):
  print 'Incoming call from ' + call['callerIdName'] + ' (' + call['callerIdNumber'] + ')'

def smsHandler(sms):
  print sms['excerpt'] + ' from: ' + sms['from']

stream.register(type='incomingcall', callback=callHandler)
stream.register(type='smsreceived', callback=smsHandler)

stream.connect()

Reference

  • sipcentric.Sipcentric(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me')
    • account
      • get()
    • callBundles
      • get()
    • recordings
      • get()
    • phoneBook
      • get()
    • timeIntervals
      • get()
    • endpoints
      • get()
    • phoneNumbers
      • get()
    • sms
      • get()
      • post(to, _from, body)
    • creditStatus
      • get()
    • calls
      • get()
    • sounds
      • get()
    • outgoingCallerIds
      • get()
    • Stream
      • register(type, callback)
      • connect()
      • disconnect()

History

This project was forked from Nimvelo's original project (for Python 2.7) python-client. The name was changed to sipcentric after discussion with the development team at Simwood.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sipcentric-0.0.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

sipcentric-0.0.0-py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page