Skip to content

Latest commit

 

History

History
executable file
·
71 lines (44 loc) · 1.88 KB

README.md

File metadata and controls

executable file
·
71 lines (44 loc) · 1.88 KB

VoiceChat is a set of APIs to create ad-hoc conferences to be used in the browser. Its built using the Plivo WebSDK and APIs.

Looking to self-host?

Automatically Deploy to Heroku

  • Create a Plivo account
  • Create and verify a Heroku account if you don't have one then click the button below.

Deploy

Manual Installation

Clone this repo

$ git clone https://github.com/plivo/voicechat.git

Configure

Create a Plivo account if you haven't already

Deploying to Heroku

Create and verify a Heroku account if you haven't.

$ cd voicechat
$ heroku create {app_name} -s cedar
$ git push heroku master
$ heroku addons:create redistogo:nano --app {app_name}
$ heroku ps:scale web=1

Add Plivo Auth ID and Auth Token to env from the dashboard.

$ heroku config:set PLIVO_AUTH_ID={PLIVO_AUTH_ID}
$ heroku config:set PLIVO_AUTH_TOKEN={PLIVO_AUTH_TOKEN}

Test your application

Go to {app_name}.herokuapp.com

API Docs

Create a conference name

POST /api/v1/conference/

Example

$ curl -XPOST http://voicechatapi.com/api/v1/conference/
{
    "conference_name": "p12ygdwt1",
    "conference_url": "http://voicechatapi.com/p12ygdwt1/"
}

Call a mobile & landline phone number (PSTN) into the bridge

POST /api/v1/conference/<conference_name>/

Parameters

to - The phone number to be called.
clid - The caller id which will be used. (The phone number to be shown in the recipient's phone.)

Example

$ curl -XPOST -d "to={1415123####}&clid={1415123####}" http://voicechatapi.com/api/v1/conference/<conference_name>/
{
    "success": True,
    "message": "Call has been queued"
}