Making Calls Using RingOut

POST /restapi/v1.0/account/~/extension/~/ring-out
Content-Type: application/json
Authorization: Bearer <access-token>

{
    "from": {"phoneNumber": "13445554444"}, /* from parameter is optional if there is a default number in user's forwarding numbers */
    "to": {"phoneNumber": "13455553434"}, /* to parameter is required */
    "playPrompt": true /* optional field */
}

const RC_SDK = require('@ringcentral/sdk').SDK
const path = require('path')
// Remember to modify the path of your .env file location!
require('dotenv').config({ path: path.resolve(__dirname, '../.env') })

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

var rcsdk = new RC_SDK({
    'server':       process.env.RC_SERVER_URL,
    'clientId':     process.env.RC_APP_CLIENT_ID,
    'clientSecret': process.env.RC_APP_CLIENT_SECRET
});
var platform = rcsdk.platform();
platform.login({ 'jwt':  process.env.RC_USER_JWT })

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

/*
* Place a ring-out call
*/
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("Unable to place a ring-out call.", e.message)
  }
}
// End of Quick Start Code Section

/**********************************************************
***********************************************************
 TEST SECTION - THESE FUNTIONS ARE NOT SHOWN IN DEV GUIDE
***********************************************************
 Code snippet section for boostrap testing purpose
**********************************************************/
const sleep = async (ms) => {
  await new Promise(r => setTimeout(r, ms));
}

exports.platform = platform;

boostrap_test_function()
async function boostrap_test_function(){
  console.log("boostrap_test_function")

  // await sleep(2000)
  // console.log("Test create a call monitoring group")
  // require ('./code-snippets/create-update-call-monitoring-group.js')
  // return
  //
  // await sleep(2000)
  // console.log("Test List Call Monitoring Groups")
  // require ('./code-snippets/call-monitoring-group.js')
  // return

  await sleep(2000)
  console.log("Test Supervise Call Session")
  require ('./code-snippets/call-supervision.js')
  return

/*
  await sleep(2000)
  console.log("Test Enrollment Speaker Identification")
  require ('./code-snippets/enrollment.js')
  return

  await sleep(2000)
  console.log("Test Summarization")
  require ('./code-snippets/summarize.js')
  return

  await sleep(2000)
  console.log("Test Speaker Diarization")
  require ('./code-snippets/speaker-diarization.js')
  return


  await sleep(2000)
  console.log("Test Speaker Identification")
  require ('./code-snippets/speaker-identifier.js')
  return

  await sleep(2000)
  console.log("Test Enrollment Extra")
  require ('./code-snippets/enrollment-extra.js')
  return

  await sleep(2000)
  console.log("Test Punctuation")
  require ('./code-snippets/punctuation.js')
  return
*/
}

from ringcentral import SDK
import os,sys,urllib.parse,json
from pathlib import Path
from dotenv import load_dotenv
load_dotenv()

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

#
#  Place a ring-out call
#
def call_ring_out():
    try:
        bodyParams = {
            'from' : { 'phoneNumber': CALLER },
            'to'   : { 'phoneNumber': RECIPIENT },
            'playPrompt' : False
        }
        endpoint = "/restapi/v1.0/account/~/extension/~/ring-out"
        resp = platform.post(endpoint, bodyParams)
        jsonObj = resp.json()
        print(f'Call placed. Call status: {jsonObj.status.callStatus}')
    except Exception as e:
        print ("Unable to place a ring-out call. " + str(e))

# Instantiate the SDK and get the platform instance
rcsdk = SDK( os.environ.get('RC_APP_CLIENT_ID'),
             os.environ.get('RC_APP_CLIENT_SECRET'),
             os.environ.get('RC_SERVER_URL') )
platform = rcsdk.platform()

# Authenticate a user using a personal JWT token
def login():
    try:
      platform.login( jwt=os.environ.get('RC_USER_JWT') )
      #call_ring_out()
    except Exception as e:
      sys.exit("Unable to authenticate to platform. Check credentials." + str(e))

login()
##############################
# End of quick start section
##############################


########
# Code snippet section for boostrap testing purpose
########
import time
def boostrap_test_function():
    time.sleep (2)
    import importlib

    # time.sleep (2)
    # print ("Test create call monitoring group")
    # ms = importlib.import_module("code-snippets.create-update-call-monitoring-group")
    # ms.platform = platform
    # ms.create_call_monitoring_group("Demo Group - Python")
    # #ms.delete_call_monitoring_group('8125017')
    #
    # time.sleep (2)
    # print ("Test list call monitoring groups and members")
    # ms = importlib.import_module("code-snippets.call-monitoring-group")
    # ms.platform = platform
    # ms.read_call_monitoring_groups()

    time.sleep (2)
    print ("Test supervise call session")
    ms = importlib.import_module("code-snippets.call-supervision")
    ms.platform = platform
    supervisorDeviceId = "802636634016"
    agentExtensionId = "62295327016"

    ms.read_agent_active_calls(agentExtensionId, supervisorDeviceId)

    #print ("")
    # time.sleep (2)
    #ms = importlib.import_module("code-snippets.enrollment")
    #ms.platform = platform
    #contentFile = os.environ.get('ENROLLMENT_CONTENT_3')
    #ms.enrollment(contentFile)

    #print ("")
    # time.sleep (2)
    #ms = importlib.import_module("code-snippets.enrollment-extra")
    #ms.platform = platform
    #ms.read_enrollments()

# must be on the last line!
boostrap_test_function()

<?php
// Remember to modify the path ./../ pointing to the location where the RingCentral SDK was installed and the .env file was saved!
require('./../vendor/autoload.php');
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__ . './../');
$dotenv->load();

$rcsdk = new RingCentral\SDK\SDK( $_ENV['RC_APP_CLIENT_ID'],
                                  $_ENV['RC_APP_CLIENT_SECRET'],
                                  $_ENV['RC_SERVER_URL'] );

$platform = $rcsdk->platform();

// Authenticate a user using a personal JWT token
try {
  $platform->login( [ "jwt" => $_ENV['RC_USER_JWT'] ] );
  //call_ring_out();
} catch (\RingCentral\SDK\Http\ApiException $e) {
  exit("Unable to authenticate to platform. Check credentials. " . $e->getMessage() . PHP_EOL);
}

/*
* Place a ring-out call
*/
function call_ring_out(){
  global $platform;
  $CALLER       = $_ENV['RINGOUT_CALLER'];
  $RECIPIENT    = $_ENV['RINGOUT_RECIPIENT'];

  try {
    $bodyParams = array(
      'from' => array('phoneNumber' => $CALLER ),
      'to' => array('phoneNumber' => $RECIPIENT),
      'playPrompt' => false
    );
    $endpoint = "/account/~/extension/~/ring-out";
    $resp = $platform->post($endpoint, $bodyParams);
    print_r ("Call placed. Call status: " . $resp->json()->status->callStatus);
  }catch (\RingCentral\SDK\Http\ApiException $e) {
    // Getting error messages using PHP native interface
    print 'HTTP Error: ' . $e->getMessage() . PHP_EOL;
    // Another way to get message, but keep in mind, that there could be no response if request has failed completely
    print 'Unable to place a ring-out call. ' . $e->apiResponse->response()->error() . PHP_EOL;
  }
}
?>


<?php
/**********************************************************
 Code snippet section for boostrap testing purpose
**********************************************************/
boostrap_test_function();
function boostrap_test_function(){

  sleep(2);
  print_r ("Test code snippets". PHP_EOL);
  //require_once (__DIR__ .'/code-snippets/create-update-call-monitoring-group.php');
  // sleep(2);
  // print_r ("Test fetching stt task status". PHP_EOL);
  // require_once (__DIR__ .'/code-snippets/create-update-call-monitoring-group.php');
  //
  // sleep(2);
  // print_r ("Test list call monitoring group". PHP_EOL);
  //require_once (__DIR__ .'/code-snippets/call-monitoring-group.php');
  require_once (__DIR__ .'/code-snippets/call-supervision.php');
}
?>

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

namespace Call_Ringout
{
  class Program
  {
    static RestClient restClient;
    static async Task Main(string[] args)
    {
      restClient = new RestClient(
      Environment.GetEnvironmentVariable("RC_APP_CLIENT_ID"),
      Environment.GetEnvironmentVariable("RC_APP_CLIENT_SECRET"),
      Environment.GetEnvironmentVariable("RC_SERVER_URL"));
      await restClient.Authorize(Environment.GetEnvironmentVariable("RC_USER_JWT"));
      await call_ringout();
    }

    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);
    }
  }
}

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_APP_CLIENT_ID"),
                             System.getenv("RC_APP_CLIENT_SECRET"),
                             System.getenv("RC_SERVER_URL") );
        try {
        rc.authorize(System.getenv("RC_USER_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);
    }
}

require 'ringcentral'
require 'dotenv'
require 'json'

# Remember to modify the path to where you saved your .env file!
Dotenv.load("./../.env")

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

#
#  Place a ring-out call
#
def call_ring_out()
    bodyParams = {
        'from': { 'phoneNumber': CALLER },
        'to': { 'phoneNumber': RECIPIENT },
        'playPrompt': false
    }
    endpoint = "/restapi/v1.0/account/~/extension/~/ring-out"
    begin
      resp = $platform.post(endpoint, payload: bodyParams)
      body = resp.body
      puts "Call placed. Call status: " + resp.body['status']['callStatus']
    rescue StandardError => e
      puts ("Unable to place a ring-out call. " + e.to_s)
    end
end

# Instantiate the SDK and get the platform instance
$platform = RingCentral.new( ENV['RC_APP_CLIENT_ID'], ENV['RC_APP_CLIENT_SECRET'], ENV['RC_SERVER_URL'] )

# Authenticate a user using a personal JWT token
def login()
  begin
    $platform.authorize(jwt: ENV['RC_USER_JWT'])
    #call_ring_out()
  rescue StandardError => e
    puts ("Unable to authenticate to platform. Check credentials." + e.to_s)
  end
end

login()
##############################
# End of quick start section
##############################


########
# Code snippet section for boostrap testing purpose
########
def boostrap_test_function()

    # sleep(2)
    # puts "Test create a call monitoring group"
    # require_relative './code-snippets/create-update-call-monitoring-group'
    # create_call_monitoring_group("Demo Group - Ruby")
    #
    # sleep(2)
    # puts "Test list call monitoring groups"
    # require_relative './code-snippets/call-monitoring-group'
    # read_call_monitoring_groups()

    sleep(2)
    puts "Test supervise call session"
    require_relative './code-snippets/call-supervision'
    supervisorDeviceId = "802636634016"
    agentExtensionId = "62295327016"
    read_agent_active_calls(agentExtensionId, supervisorDeviceId)
end

boostrap_test_function()