Artificial Intelligence API Quick Start Guide

$ npm install @ringcentral/sdk
$ npm install dotenv

const http = require('http');
const PORT = 8080;

// Create a server to receive callback from RingCentral
const server = http.createServer( function(req, res) {
    if (req.method == 'POST' && req.url == "/webhook") {
        console.log("Response received from RingCentral...");
        if (req.headers.hasOwnProperty("validation-token")) {
            res.setHeader('Content-type', 'application/json');
            res.setHeader('Validation-Token', req.headers['validation-token']);
        } 
        let body = []
        req.on('data', function(chunk) {
            body.push(chunk);
        }).on('end', function() {
            body = Buffer.concat(body).toString();
            console.log(JSON.stringify(JSON.parse(body),null,4));
            res.statusCode = 200;
            res.end();
        });
    } else {
        console.log("Unknown HTTP content received")
    }
});

// Start the server
try {
    server.listen(PORT);
} catch (e) {
    console.log("There was a problem starting the server: " + e)
}
console.log("Artificial Intelligence response server running at: https://localhost:" + PORT)

$ node server.js

$ pip install pprintpp

import os,sys
import logging
import requests
import json
from http.server import BaseHTTPRequestHandler, HTTPServer

# Server config. Set this to your local server and port
HOSTNAME = "localhost"
PORT     = 8080

# Handle Incoming HTTP requests
class S(BaseHTTPRequestHandler):
    def _set_response(self):
        self.send_response(200)
        self.send_header('Content-type', 'text/html')
        self.end_headers()

    def do_POST(self):
        content_length = int(self.headers['Content-Length']) 
        post_data = self.rfile.read(content_length) 
        print( json.dumps(json.loads(post_data), indent=2, sort_keys=True))
        self._set_response()

def run(server_class=HTTPServer, handler_class=S, hostName='localhost', port=8080):
    logging.basicConfig(level=logging.INFO)
    server_address = (HOSTNAME, port)
    httpd = server_class(server_address, handler_class)
    logging.info('Artificial Intelligence response server running at: https://%s:%s\n', hostName, port)
    try:
        httpd.serve_forever()
    except KeyboardInterrupt:
        pass
    httpd.server_close()
    logging.info('Artificial Intelligence response server stopping...\n')

try:
    run( hostName = HOSTNAME, port=PORT )
except Exception as e:
    print(e)

$ python server.py

$ npm install @ringcentral/sdk
$ npm install dotenv

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

// Read instructions on running code samples to include all required variables
// https://developers.ringcentral.com/guide/basics/code-samples
NGROK       = "<INSERT NGROK URL>"
WEBHOOK_URL = NGROK + "/webhook";
CONTENT_URI = 'https://github.com/ringcentral/ringcentral-api-docs/blob/main/resources/sample1.wav?raw=true'

// Initialize the RingCentral SDK and Platform
const rcsdk = new RC({
    'server':       process.env.RC_SERVER_URL,
    'clientId':     process.env.RC_CLIENT_ID,
    'clientSecret': process.env.RC_CLIENT_SECRET
});

const platform = rcsdk.platform();
platform.login({'jwt':  process.env.RC_JWT})
platform.on(platform.events.loginSuccess, () => {
    speechToText();
})

async function speechToText() {
    try {
        console.log("Calling RingCentral Speech To Text API");
        let resp = await platform.post("/ai/audio/v1/async/speech-to-text?webhook=" + WEBHOOK_URL, {
            "contentUri":               CONTENT_URI,
            "encoding":                 "Wav",
            "languageCode":             "en-US",
            "source":                   "RingCentral",
            "audioType":                "Meeting",
            "enablePunctuation":        true,
            "enableSpeakerDiarization": false
        });
    let json = await resp.json();
        console.log("Request: " + resp.statusText);
    console.log("Status code: " + resp.status);
        if (resp.status == 202) {
        console.log("Job ID: " + json.jobId);
            console.log("Ready to receive response at: " + WEBHOOK_URL);
        } else {
            console.log("An error occurred posting the request.");
        }
    } 
    catch (e) {
        console.log("An error occurred : " + e.message);
    }
}

$ node index.js

$ pip install ringcentral
$ pip install python-dotenv

#!/usr/bin/env python
from ringcentral import SDK
import os,sys,urllib.parse
from dotenv import load_dotenv
load_dotenv()

# Read instructions on running code samples to include all required variables
# https://developers.ringcentral.com/guide/basics/code-samples
NGROK       = "<INSERT NGROK URL>"
WEBHOOK_URL = NGROK + "/webhook"
CONTENT_URI = 'https://github.com/ringcentral/ringcentral-api-docs/blob/main/resources/sample1.wav?raw=true'

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("/ai/audio/v1/async/speech-to-text?webhook=" + urllib.parse.quote(WEBHOOK_URL), {
  "contentUri":               CONTENT_URI,
  "encoding":                 "Wav",
  "languageCode":             "en-US",
  "source":                   "RingCentral",
  "audioType":                "Meeting",
  "enablePunctuation":        True,
  "enableSpeakerDiarization": False
})

print(f'Request:     {resp.response().reason}');
print(f'Status code: {resp.response().status_code}');
if resp.response().status_code == 202:
  print(f'Job ID:      {resp.json().jobId}');
  print(f'Ready to receive response at: {WEBHOOK_URL}');
else:
  print(f'An error occurred posting the request.');

$ python index.py

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

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

// For the purpose of testing the code, we put the SMS recipient number in the environment variable.
// Feel free to set the SMS recipient directly.
$RECIPIENT    = $_ENV['SMS_RECIPIENT'];

# Instantiate the SDK and get the platform instance
$rcsdk = new RingCentral\SDK\SDK( $_ENV['RC_CLIENT_ID'],
                                  $_ENV['RC_CLIENT_SECRET'],
                                  $_ENV['RC_SERVER_URL'] );
$platform = $rcsdk->platform();

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

/*
  Read phone number(s) that belongs to the authenticated user and detect if a phone number
  has the SMS capability
*/
function read_extension_phone_number_detect_sms_feature(){
  global $platform;
  $endpoint = "/restapi/v1.0/account/~/extension/~/phone-number";
  $resp = $platform->get($endpoint);
  $jsonObj = $resp->json();
  foreach ($resp->json()->records as $record){
    foreach ($record->features as $feature){
      if ($feature == "SmsSender"){
        // If a user has multiple phone numbers, check and decide which number
        // to be used for sending SMS message.
        return send_sms($record->phoneNumber);
      }
    }
  }
  if (count($jsonObj->records) == 0){
    exit("This user does not own a phone number!");
  }else{
    exit("None of this user's phone number(s) has the SMS capability!");
  }
}

/*
 Send a text message from a user own phone number to a recipient number
*/
function send_sms($fromNumber){
  global $platform, $RECIPIENT;
  try {
    $requestBody = array(
       'from' => array ('phoneNumber' => $fromNumber),
       'to' => array( array('phoneNumber' => $RECIPIENT) ),
       // To send group messaging, add more (max 10 recipients) 'phoneNumber' object. E.g.
       /*
       'to' => array(
          array('phoneNumber' => $RECIPIENT),
          array('phoneNumber' => 'Recipient-Phone-Number')
        ),
       */
       'text' => 'Hello World!'
    );
    $endpoint = "/account/~/extension/~/sms";
    $resp = $platform->post($endpoint, $requestBody);
    $jsonObj = $resp->json();
    print("SMS sent. Message id: " . $jsonObj->id . PHP_EOL);
    check_message_status($jsonObj->id);
  } catch (\RingCentral\SDK\Http\ApiException $e) {
    exit("Error message: " . $e->message . PHP_EOL);
  }
}

/*
 Check the sending message status until it's out of the queued status
*/
function check_message_status($messageId){
    global $platform;
    try {
        $endpoint = "/restapi/v1.0/account/~/extension/~/message-store/".$messageId;
        $resp = $platform->get($endpoint);
        $jsonObj = $resp->json();
        print("Message status: " . $jsonObj->messageStatus . PHP_EOL);
        if ($jsonObj->messageStatus == "Queued"){
          sleep(2);
          check_message_status($jsonObj->id);
        }
    } catch (\RingCentral\SDK\Http\ApiException $e) {
      exit("Error message: " . $e->message . PHP_EOL);
    }
}
?>


<?php
/**********************************************************
 Code snippet section for boostrap testing purpose
**********************************************************/
$RECIPIENT2    = $_ENV['SMS_RECIPIENT2'];
boostrap_test_function();
function boostrap_test_function(){
  /*
  print_r ("Test reading number features". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/number-features.php');

  return
  print_r ("Test sending MMS". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/send-mms.php');

  print_r ("Test sending Fax". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/send-fax.php');

  print_r ("Test reading message store". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/message-store.php');

  print_r ("Test export message store". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/message-store-export.php');
  */

  print_r ("Test sending a2p SMS". PHP_EOL);
  sleep(2);
  include_once (__DIR__ .'/code-snippets/send-a2p-sms.php');
}
?>

$ php index.php