Skip to main content

PIOPIY REST API for Python

Project description

PIOPIY Python SDK

The PIOPIY python SDK is used to integrate communications into your python applications using the PIOPIY REST API. Using the PIOPIY python SDK, you will be able to make voice calls and can control your call flows.

Install

Follow the below installation instructions

Prerequisites

Prerequisites for javascript web server.

  • python (>= 2.7.16 required)
  • pip (>= 18.1 required)

Installation

Install the SDK using npm

$ pip install piopiy

Authentication

In order to authenticate your app, and to make an API request, you should have an app id and secret for authentication. Find your App ID and secret in your PIOPIY dashboard

Specifiy the authentication credentials

import piopiy
client=piopiy.RestClient('your_app_id','your_app_secret')

Make a call

To make a call, mention the to_number, piopiy_phone_number and answer_url.

response=client.make(
     'your_to_number',
     'your_piopiy_phone_number',
     'your_answer_url'
)

Hold a call

To hold a call, mention the cmiuuid of the call.

response=client.hold('cmiuuid')

Unhold a call

To unhold a call, mention the cmiuuid of the call.

response=client.unhold('cmiuuid')

Toggle a call

To toggle a call, mention the cmiuuid of the call.

response=client.toggle('cmiuuid')

Hangup a call

To Hangup a call, mention the cmiuuid of the call.

response=client.hanup('cmiuuid')

More Examples

Refer to the piopiy docs for more examples. Now create the PIOPIY account and setup the flask server and test out your integration in few minutes.

Reporting issues

For any feedbacks and problems, you can report us by opening an issue on github.

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

piopiy-0.7.1.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

piopiy-0.7.1-py3-none-any.whl (6.3 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