opurva 1.0.0

SDK for Opurva API client and TwiML generator

opurva-python

Supported Python Versions

This library supports the following Python implementations:

• Python 3.7
• Python 3.8
• Python 3.9
• Python 3.10
• Python 3.11

Installation

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

pip3 install opurva

If pip install fails on Windows, check the path length of the directory. If it is greater 260 characters then enable Long Paths or choose other shorter location.

Don't have pip installed? Try installing it, by running this from the command line:

$ curl https://bootstrap.pypa.io/get-pip.py | python

Getting Started

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

API Credentials

The opurva needs your opurva credentials. You can either pass these directly to the constructor.

from opurva.rest import Client

account = "AAAAAAAAAAAA"
token = "BBBBBBBBBBBBBBBBBBBBBBB"
client = Client(account, token)

Make a Call

from opurva.rest import Client

account = "AAAAAAAAAAAA"
token = "BBBBBBBBBBBBBBBBBBBBBBB"
client = Client(account, token)

call = client.calls.create(to="122122313",
                           from="12112121",
                           url="https://raw.githubusercontent.com/opurva/public/master/answer_speak.xml")
print(call.sid)

Send an SMS

from opurva.rest import Client

account = "AAAAAAAAAAAA"
token = "BBBBBBBBBBBBBBBBBBBBBBB"
client = Client(account, token)

message = client.messages.create(to="122122313", from="12112121",
                                 body="Hello there!")

Enable Debug Logging

Log the API request and response data to the console:

import logging

client = Client(account, token)
logging.basicConfig()
client.http_client.logger.setLevel(logging.INFO)

Log the API request and response data to a file:

import logging

client = Client(account, token)
logging.basicConfig(filename='./log.txt')
client.http_client.logger.setLevel(logging.INFO)

Generating TinyXML

To control phone calls, your application needs to output [TinyXML][TinyXML].

Use opurva.voice_response or opurva.messaging_response to easily create such responses.

from opurva.voice_response import VoiceResponse

r = VoiceResponse()
r.say("Welcome to TinyXML!")
print(str(r))

<?xml version="1.0" encoding="utf-8"?>
<Response><Say>Welcome to TinyXML!</Say></Response>