RingCentral EX - Call Authentication

Pre-requisites

  1. Annual Contract Agreement with First Orion Branded Communications (Post paid)
  2. RingCentral EX enabled in First Orion account (See your First Orion contact for more information)
  3. Access to First Orion Customer Portal
  4. Vetted and Approved Business
  5. RingCentral developer portal access

Expectations

  1. Customer can facilitate changes to the RingCentral platform for configuration
  2. Access to RingCentral Developer portal to manage API credentials
  3. Thorough testing involving customer and First Orion
  4. Proper lead time to schedule “go live” between customer and First Orion Pre-Requisites

Notice!!

This integration is a collaborative effort between the client and First Orion. Please reach out to your First Orion contact to find out more information.

Step 1: Create Call Authentication Program

  1. See the Call Authentication Guide for detailed Program creation instructions.
  2. Add the RingCentral EX phone numbers into the Call Authentication Program.

Step 2: Create Call Auth app in RingCentral

  1. In the RingCentral Developer Portal, navigate to the Console page.
  2. Click Register App
  3. Select REST API App the click Next
  4. Fill out the name and description
  5. Under the Auth section, select JWT Auth Flow
  6. Under Security add these permissions.
    1. Call Control, Read Call Log, Read Presence, WebSocket, WebSocket Subscriptions
  7. We will download this later

Step 3: Create JWT Credentials

This is different than the JWT in the app JSON file.

  1. Hover over the username in the top right and click Credentials.
  2. Click create a JWT and assign it to the Call Auth app that was just created.
  3. Save this JWT. It should also be in the JSON file in the next step.

Step 4: Save and Share Credentials with First Orion

  1. In the Developer Portal, navigate to the Console page.
  2. Click on the App created earlier.
  3. Click Download next to Credentials JSON. This should contain the Client ID, Client Secret and the JWT generated in Step 2.
  4. Reach out to your First Orion contact to securely share these Credentials
Download Credentials

Example Credential JSON File

{
    "clientId": "RUV4b0NIC90ZK3tLyMiBKZ",
    "clientSecret": "xUlxqagAakx7PsoDKaehsWsXm7Z01GH9mlQOgXrKpRWx",
    "server": "https://platform.ringcentral.com",
    "jwt": {
        "CallAuth JWT": "eyJrabvqVBa7kKWsyGMRfh46wl03S32YD6QbykGmtSFqRxViSZE140hrQ5dZkKmNZnNTfpWUZj4YyHqkwSuctg19o6F6KkBlXBLWN2sX1cV48SmB8mQZcUx64xgqyWc7oAga9IfYCdC4fKD3zsdsp0OArRBzt1UxW1Q3jnUEhewlJvinXtJbErDSvaEEyfSY721PJRzU8VCMwBEiUHqFJuu6gaLCsVycPOCyaLJq6lLyq8EZVX9B0DBKsXfGwxevk3kgqS9vHsZ4PbCJ7AGmPvXHceo7E7UjShxS55uyCf0tvqBLbdQW7uX3121QJW8x8rpzedxpOZpZuEy2IBB0G76xCrgZhEROAALr5kWKzYti5pP9sIJm6kFnVLHWDccTO0nTkmOHYw10VYASDrUSDiLMbtZHhZf2R9fsN6846YcVl0XJ2yAwzhn1khbrXeygzLgmEahyM7NTmd9a3o9wHL46B7ot3fUH6FrFFIcw7DIhRD6ygwfVVtRJppalXvY3sXssfdiiYYxVYUjpGkFHiixQIrXxnrit4KRvSmUafi4hRLwX2SiFfSChOTUWcTkyKClGSXD65DFrmxfFJRrBzyxBNTvxa3QisauQ4fJg7sBloQR1Je491tjsbxxKyKpSDphU09YJioJAxdxvTNLRGguRtHf4z6sEwsOVULV4NFN",
}

Step 5: First Orion connects your integration

In this step First Orion will take the shared credentials to finish setting up the RingCentral EX integration and notify you when it is ready. This may be done on a call with First Orion.

Step 6: Make Phone Calls

Test phone calls from your RingCentral EX phone numbers that have been added to a Call Auth Program.

Troubleshoot Checklist

  1. Verify First Orion has enabled the RingCentral EX integration
  2. Create Call Authentication Program
  3. Add Phone numbers to Call Authentication Program