cpaas-python

This python package is an open source tool built to simplify interaction with the CPaaS telephony platform. Avaya CPaaS makes adding voice and SMS to applications fun and easy.

For more information about CPaaS, please visit: Avaya CPaaS

To read the official documentation, please visit: CPaaS Docs.

Installation

Clone the repo, and install via pip:

$ git clone git@github.com:avaya/cpaas-python.git
$ cd cpaas-python
$ pip install -e .

Usage

REST

See the CPaaS REST API documentation for more information.

Send SMS Example

from datetime import date
from zang import ZangException, Configuration, ConnectorFactory

sid = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
authToken = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
url = 'http://api.zang.io/v2'

configuration = Configuration(sid, authToken, url=url)
smsMessagesConnector = ConnectorFactory(configuration).smsMessagesConnector

# send sms message
try:
    smsMessage = smsMessagesConnector.sendSmsMessage(
        to='(XXX) XXX-XXXX',
        body='Hello from Avaya CPaaS!',
        from_='(XXX) XXX-XXXX')
    # This prints the SID of the SMS
    print(smsMessage.sid)
except ZangException as ze:
    print(ze)

Configuration

First a configuration object must be created by using Configuration class.

Normally you'll want to just enter your CPaaS Platform Account sid and authToken, but you can also define a base API URL.

Next you'll have to create a connector by using ConnectorFactory. This can be done in multiple ways. The usual way is to instantiate ConnectorFactory, pass the configuration object to the factory and have it instantiate ZangConnector objects:

callsConnector = ConnectorFactory(configuration).callsConnector
callsConnector.makeCall(...)

Request parameters

Request parameters are passed as parameters to connector object methods as shown previously. All methods use the Account sid parameter specified in the configuration automatically:

usagesConnector = ConnectorFactory(configuration).usagesConnector
# Account sid from configuration used automatically
usage = usagesConnector.viewUsage('{UsageSid}')

Methods usually have optional parameters. To specify an optional parameter, use parameterName=value in a method call e.g.:

call = callsConnector.makeCall(
    '+123456',
    '+654321',
    'TestUrl',
    method=HttpMethod.GET,
    fallbackUrl='FallbackUrl')

Response data

The received data can be an object, e.g.:

usagesConnector = ConnectorFactory(configuration).usagesConnector
usage = usagesConnector.viewUsage('{UsageSid}')
print(usage.totalCost)

Or a list of objects in which case the list is iterable, e.g.:

usagesConnector = ConnectorFactory(configuration).usagesConnector
usages = usagesConnector.listUsages(
    product=Product.ordinal(Product.OUTBOUND_CALL),
    year=2017,
    month=2,
    pageSize=100)
if usages and usages.elements:
    for usage in usages.elements:
        print(usage.totalCost)

InboundXML

InboundXML is an XML dialect which enables you to control phone call flow. For more information please visit the CPaaS InboundXML documentation.

<Say> Example

from zang.inboundxml import Response, Say

# enums
from zang.inboundxml import Voice, Language

say = Say("Welcome to Avaya CPaaS!",
          language=Language.EN,
          voice=Voice.FEMALE,
          loop=3)

response = Response()
response.addElement(say)

print(response.xml)

will render

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
    <Say loop="3" voice="female" language="en">Welcome to Zang!</Say>
</Response>