RingOut Quick Start

Last updated: 2023-06-22

Contributors

Calling the RingCentral API for the first time? We recommend you try out getting started experience.

In this quick start, we are going to help you connect two people in a live phone call using our RingOut API, which dials two phone numbers, and then connects the two people when they answer. Let's get started.

Create an app and obtain credentials

The first thing we need to do is create an app in the RingCentral Developer Console. This can be done quickly by clicking the "Create RingOut App" button below. Just click the button, enter a name and description if you choose, and click the "Create" button. If you do not yet have a RingCentral account, you will be prompted to create one.

Create RingOut App Show detailed instructions

Login or create an account if you have not done so already.
Go to Console/Apps and click 'Create App' button.
Select "REST API App" under "What type of app are you creating?" Click "Next."
Under "Auth" select "JWT auth flow."
Under "Security" add the following permissions:
- RingOut
Under "Security" select "This app is private and will only be callable using credentials from the same RingCentral account."

When you are done, you will be taken to the app's dashboard. Make note of the Client ID and Client Secret. We will be using those momentarily.

Download and edit a `.env` file

Follow the instructions found in our guide to running Developer Guide code samples. Or:

Download our env-template and save it as a file named .env.
Edit your newly downloaded .env file, setting its variables with the proper values for the app you created above, paying close attention to the following:
- RC_CLIENT_ID - set to the Client ID of the app you created above
- RC_CLIENT_SECRET - set to the Client Secret of the app you created above
- RC_JWT - set to the JWT credential you created for yourself
- RINGOUT_SENDER - set to a RingCentral phone number you wish to place the call from in this code sample
- RINGOUT_RECIPIENT - set to a phone number you wish to call in this code sample

Place a Call

Select your preferred language below.

Javascript

Install RingCentral JavaScript SDK

$ npm install @ringcentral/sdk --save

Create and edit ringout.js

Create a file called ringout.js. Be sure the values in your .env file have been set properly.

const RC = require('@ringcentral/sdk').SDK
require('dotenv').config();

const CALLER       = process.env.RINGOUT_CALLER
const RECIPIENT    = process.env.RINGOUT_RECIPIENT

var rcsdk = new RC({
    'server':       process.env.RC_SERVER_URL,
    'clientId':     process.env.RC_CLIENT_ID,
    'clientSecret': process.env.RC_CLIENT_SECRET
});
var platform = rcsdk.platform();
platform.login({ 'jwt':  process.env.RC_JWT })

platform.on(platform.events.loginSuccess, () => {
  call_ringout()
})

async function call_ringout() {
  try {
    var resp = await platform.post('/restapi/v1.0/account/~/extension/~/ring-out', {
      'from': { 'phoneNumber': CALLER },
      'to': { 'phoneNumber': RECIPIENT },
      'playPrompt': false
    })
    var jsonObj = await resp.json()
    console.log("Call placed. Call status: " + jsonObj.status.callStatus)
  } catch (e) {
    console.log(e.message)
  }
}

Run your code

You are almost done. Now, load your variables into your local environment, and run your script.

$ source .env
$ node ringout.js

Python

Install RingCentral Python SDK

$ pip install ringcentral python-dotenv

Create and edit ringout.py

Create a file called ringout.py. Be sure the values in your .env file have been set properly, including the RINGOUT_RECIPIENT variable.

#!/usr/bin/python

# You get the environment parameters from your 
# application dashbord in your developer account 
# https://developers.ringcentral.com

import os
import sys

from dotenv import load_dotenv
from ringcentral import SDK
load_dotenv()

CALLER    = os.environ.get('RINGOUT_CALLER')
RECIPIENT = os.environ.get('RINGOUT_RECIPIENT')

rcsdk = SDK( os.environ.get('RC_CLIENT_ID'),
             os.environ.get('RC_CLIENT_SECRET'),
             os.environ.get('RC_SERVER_URL') )
platform = rcsdk.platform()
try:
  platform.login( jwt=os.environ.get('RC_JWT') )
except Exception as e:
  sys.exit("Unable to authenticate to platform: " + str(e))

resp = platform.post('/restapi/v1.0/account/~/extension/~/ring-out',
              {
                  'from' : { 'phoneNumber': CALLER },
                  'to'   : { 'phoneNumber': RECIPIENT },
                  'playPrompt' : False
              })
print(f'Call placed. Call status: {resp.json().status.callStatus}')

Run your code

You are almost done. Now run your script.

$ python ringout.py

PHP

Install RingCentral PHP SDK

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require ringcentral/ringcentral-php vlucas/phpdotenv

Create and edit ringout.php

Create a file called ringout.php. Be sure the values in your .env file have been set properly, including the RINGOUT_RECIPIENT variable.

<?php
/* You get the environment parameters from your 
   application dashbord in your developer account 
   https://developers.ringcentral.com */

require('vendor/autoload.php');
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__ . '/../');
$dotenv->load();

$CALLER       = $_ENV['RINGOUT_CALLER'];
$RECIPIENT    = $_ENV['RINGOUT_RECIPIENT'];

$rcsdk = new RingCentral\SDK\SDK( $_ENV['RC_CLIENT_ID'],
                                  $_ENV['RC_CLIENT_SECRET'],
                                  $_ENV['RC_SERVER_URL'] );
$platform = $rcsdk->platform();
$platform->login( [ "jwt" => $_ENV['RC_JWT'] ] );

$resp = $platform->post('/account/~/extension/~/ring-out',
    array(
      'from' => array('phoneNumber' => $CALLER ),
      'to' => array('phoneNumber' => $RECIPIENT),
      'playPrompt' => false
    ));

print_r ("Call placed. Call status: " . $resp->json()->status->callStatus);
?>

Run your code

You are almost done. Now run your script.

$ php ringout.php

Ruby

Install RingCentral Ruby SDK

$ gem install ringcentral-sdk dotenv

Create and edit ringout.rb

Create a file called ringout.rb. Be sure the values in your .env file have been set properly, including the RINGOUT_RECIPIENT variable.

#!usr/bin/ruby

# You get the environment parameters from your 
# application dashbord in your developer account 
# https://developers.ringcentral.com

require 'ringcentral'
require 'dotenv/load'

CALLER    = ENV['RINGOUT_CALLER']
RECIPIENT = ENV['RINGOUT_RECIPIENT']

$rc = RingCentral.new(ENV['RC_CLIENT_ID'],
                      ENV['RC_CLIENRT_SECRET'],
                      ENV['RC_SERVER_URL'])

$rc.authorize(jwt: ENV['RC_JWT'])

resp = $rc.post('/restapi/v1.0/account/~/extension/~/ring-out', payload: {
    from: { phoneNumber: CALLER },
    to: { phoneNumber: RECIPIENT },
    playPrompt: false
})

puts "Call placed. Call status: " + resp.body['status']['callStatus']

Run your code

You are almost done. Now run your script.

$ ruby ringout.rb

Create a Visual Studio project

Choose Console Application .Net Core -> App
Select Target Framework .NET Core 2.1
Enter project name "Call_Ringout"
Add NuGet package RingCentral.Net (4.1.0) SDK

Edit the file Program.cs

Be sure to edit the variables in ALL CAPS with your app and user credentials. Be sure to also set the recipient's phone number.

using System;
using System.Threading.Tasks;
using RingCentral;

namespace Call_Ringout
{
    class Program
    {
        static RestClient restClient;
        static void Main(string[] args)
        {
            restClient = new RestClient(
                Environment.GetEnvironmentVariable("RC_CLIENT_ID"),
                Environment.GetEnvironmentVariable("RC_CLIENT_SECRET"),
                Environment.GetEnvironmentVariable("RC_SERVER_URL"));
            restClient.Authorize(
                Environment.GetEnvironmentVariable("RC_JWT")).Wait();
            call_ringout().Wait();
        }

        static private async Task call_ringout()
        {
            var parameters = new MakeRingOutRequest();
            parameters.from = new MakeRingOutCallerInfoRequestFrom {
                phoneNumber = Environment.GetEnvironmentVariable("RINGOUT_CALLER")
            };
            parameters.to = new MakeRingOutCallerInfoRequestTo {
                phoneNumber = Environment.GetEnvironmentVariable("RINGOUT_RECIPIENT")
            };
            parameters.playPrompt = false;

            var resp = await restClient.Restapi().Account().Extension().RingOut().Post(parameters);
            Console.WriteLine("Call Placed. Call status" + resp.status.callStatus);
        }
    }
}

Run Your App

You are almost done. Now run your app from Visual Studio.

Java

Create a Java project (using Eclipse IDE)

Create a new Java project
Select the Gradle Project wizard
Enter project name "Call_RingOut"
Open the build.gradle file and add the RingCentral Java SDK to the project as shown below:

dependencies {
    // ...
    compile 'com.ringcentral:ringcentral:1.4.0'
}

Right-click the project in the Package Explorer and choose "Refresh Gradle Project" under the "Gradle" sub-menu

Create a new Java Class

Select "File -> New -> Class" to create a new Java class named "RingoutQuickStart"

package RingoutQuickStart;

public class RingoutQuickStart {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }
}

Edit the file "RingoutQuickStart.java".

Be sure to edit the variables in ALL CAPS with your app and user credentials. Be sure to also set the recipient's phone number.

import com.ringcentral.*;
import com.ringcentral.definitions.*;
import java.io.IOException;

public class RingoutQuickStart {
    static String RINGOUT_CALLER    = System.getenv("RINGOUT_CALLER");
    static String RINGOUT_RECIPIENT = System.getenv("RINGOUT_RECIPIENT");
    static RestClient rc;

    public static void main(String[] args) {
        var obj = new RingoutQuickStart();
        rc = new RestClient( System.getenv("RC_CLIENT_ID"),
                             System.getenv("RC_CLIENT_SECRET"),
                             System.getenv("RC_SERVER_URL") );
        try {
        rc.authorize(System.getenv("RC_JWT"));
            obj.call_ringout();
        } catch (RestException | IOException e) {
            e.printStackTrace();
        }
    }
    public void call_ringout() throws RestException, IOException {
        MakeRingOutRequest requestBody = new MakeRingOutRequest();
        requestBody.from(new MakeRingOutCallerInfoRequestFrom().phoneNumber(
              RINGOUT_CALLER ));
        requestBody.to(new MakeRingOutCallerInfoRequestTo().phoneNumber(
          RINGOUT_RECIPIENT));
        requestBody.playPrompt = false;

        var response = rc.restapi().account().extension().ringOut().post(requestBody);
        System.out.println("Call Placed. Call status: " + response.status.callStatus);
    }
}

Run Your App

You are almost done. Now run your app from Eclipse.

Need Help?

Having difficulty? Feeling frustrated? Receiving an error you don't understand? Our community is here to help and may already have found an answer. Search our community forums, and if you don't find an answer please ask!

Search the forums »

What's Next?

When you have successfully made your first API call, it is time to take your next step towards building a more robust RingCentral application.

Take your next step »

RingOut Quick Start

Create an app and obtain credentials

Download and edit a .env file

Place a Call

Install RingCentral JavaScript SDK

Create and edit ringout.js

Run your code

Install RingCentral Python SDK

Create and edit ringout.py

Run your code

Install RingCentral PHP SDK

Create and edit ringout.php

Run your code

Install RingCentral Ruby SDK

Create and edit ringout.rb

Run your code

Create a Visual Studio project

Edit the file Program.cs

Run Your App

Create a Java project (using Eclipse IDE)

Create a new Java Class

Edit the file "RingoutQuickStart.java".

Run Your App

Need Help?

What's Next?

Download and edit a `.env` file