FAELIX/sipcentric
2
0
Fork 0
Code Issues Releases Wiki Activity

rename from nimvelo3 to sipcentric

Browse Source
This commit is contained in:
Marek Isalski
2022-01-13 11:51:53 +00:00
parent 23ccc01d5b
commit f2ce5f4bac
6 changed files with 65 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.md
View File

@ -1,11 +1,13 @@
# Nimvelo Python Client
# Simwood Partner Python Client
Modern Python client library for the Nimvelo/Sipcentric API
A modern Python client library for Sipcentric
([Simwood Partner](https://simwood.com/uk/partner/), formerly Nimvelo)
[API](https://developer.simwood.com/docs/direct/introduction/).
```python
from nimvelo3 import Nimvelo
nimvelo = Nimvelo(username="myusername", password="mypassword")
print nimvelo.sms.post(_from="0123", to="03301201200", body="Hello World!")
from sipcentric import Sipcentric
api = Sipcentric(username="myusername", password="mypassword")
print api.sms.post(_from="0123", to="03301201200", body="Hello World!")
```
## Install
@ -13,15 +15,15 @@ print nimvelo.sms.post(_from="0123", to="03301201200", body="Hello World!")
### Best method
```
sudo pip install nimvelo
sudo pip install sipcentric
```
*You may need to install `simplejson` and `multiprocessing` if you don't have them already.*
*You may need to install `simplejson` if you don't have it already.*
### Manual method
```
git clone git@github.com:faelix/nimvelo3.git && cd nimvelo3
git clone git@github.com:faelix/sipcentric.git && cd sipcentric
sudo python setup.py install
```
@ -32,20 +34,20 @@ sudo python setup.py install
**Get account details**
```python
from nimvelo3 import Nimvelo
from sipcentric import Sipcentric
nimvelo = Nimvelo(username="myusername", password="mypassword")
api = Sipcentric(username="myusername", password="mypassword")
print nimvelo.account.get()
print api.account.get()
```
**Connect to the streaming api**
```python
from nimvelo3 import Nimvelo
from sipcentric import Sipcentric
nimvelo = Nimvelo(username="myusername", password="mypassword")
stream = nimvelo.Stream
api = Sipcentric(username="myusername", password="mypassword")
stream = api.Stream
def callHandler(call):
print 'Incoming call from ' + call['callerIdName'] + ' (' + call['callerIdNumber'] + ')'
@ -61,7 +63,7 @@ stream.connect()
## Reference
- nimvelo3.Nimvelo(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me')
- sipcentric.Sipcentric(username, password, base='https://pbx.sipcentric.com/api/v1', customer='me')
- account
- get()
- callBundles
@ -94,4 +96,6 @@ stream.connect()
## History
This project was forked from Nimvelo's original project (for Python 2.7) [python-client](https://github.com/Nimvelo/python-client). The name was changed to `nimvelo3` to make migration to Python 3.x codebases as simple as possible.
This project was forked from Nimvelo's original project (for Python 2.7)
[python-client](https://github.com/Nimvelo/python-client). The name was
changed to `sipcentric` after discussion with the development team at Simwood.