Requirements

• Chrome or Firefox web browser
• and a RingCentral Office® account.

Log into Notifications +

Log in to Notifications+ using your RingCentral® credentials at the following URL:

https://notificationsplus.ps.ringcentral.com

New accounts automatically receive a free 14-day trial period upon first login. After the trial period expires, you must contact your Account Executive or Sales Representative to purchase a subscription for your account.

First Login

Upon first login to application, you will need to acknowledge the 911 regulations. Please review all the information before confirming.

Notifications+ allows you to configure notifications for inbound and outbound call events on your RingCentral® account. Notifications are customizable and delivered in real-time via SMS, email, webhook or Glip®. A summary of available features includes:

• Alerts when sensitive or inappropriate numbers are called from your account, including who placed the call.
• Know who called for help and where they are in the event of an emergency.
• Customizable notification triggers, message content and delivery options.
• Bulk orchestration of notifications and settings.
• Simulation mode to test notifications without needing to actually trigger them.

Requirements

Chrome or Firefox web browser and a RingCentral Office® account.

Logging In

Log in to Notifications+ using your RingCentral® credentials at the following URL:

https://notificationsplus.ps.ringcentral.com

New accounts automatically receive a free 14-day trial period upon first login. After the trial period expires, you must contact your Account Executive or Sales Representative to purchase a subscription for your account.

Building Your First Notification

After logging in you are presented with the notifications screen. This is where all notifications and their settings are managed. A default 911 Notification has already been populated for you. If turned on, this default notification will alert you if any user on your RingCentral® account calls 911.

To get started, we'll walkthrough setting up and using an example notification together.  This notification will alert us if any user on our RingCentral® account places a call to +18885287464 (the RingCentral® support phone number):

1. First, click the +New Notification button to begin configuring a new notification. Give the new notification a friendly name, this example will use RingCentral Support.
2. Next, provide the phone number that, when called from your RingCentral® account, will trigger this notification. In this example it's +18885287464.
3. Set the call direction that will trigger this notification. In this example, we only want to know if a user from our account makes a call to +18885287464, so select Outbound.
4. Now decide which call objects can trigger this notification (e.g. what users/extensions or sites will trigger this notification when calling +18885287464). For this example, accept the "all users" default and click Next. This means that when any user on your account calls +18885287464, a notification will be triggered.
5. Select the delivery method(s) used to receive the notifications and define the content of the notification's message. The delivery methods are: SMS, email, webhook or Glip®. For this example, let's try SMS. Enter the phone number(s) you'd like to use to receive the notifications (e.g. your phone number) into the SMS field. Separate multiple numbers with commas.
6. Lastly, define the content of the notification's message. This is the text you will see when receiving the notification. Click into the text area and type the words RingCentral support called on:, then click on the Timestamp variable to the right. The timestamp variable embeds the actual event's date/time into the notification's message content. Go ahead and add the remaining variables so you can observe their behavior while testing the notification.
7. When you are finished, click Next to confirm and then click Create to create the new notification.
8. Let's test it! From the notifications home screen, click the checkbox next to your new notification then click Simulate. You should receive an SMS shortly containing the notification. You can use the simulate feature to test any notification you have configured without actually triggering the notification.

Wrapping Up

This is just one example of the flexibility that Notifications+ offers. Use it to ensure compliance with FCC-mandated Kari's Law, get alerts when sensitive or inappropriate numbers are called from your account (for example pay-per-call and premium rate numbers) and much more.

Notifications+ is available in the RingCentral App Gallery. For any questions or additional information please contact RingCentral Support.

To purchase a subscription once your trial period has expired, please contact your Account Executive or Sales Representative.

Notifications+ is powered by RingCentral® Professional Services.

The Notifications+ interface is fairly simple and contains several functions to help you organize, create, and manage multiple notifications for your RingCentral Office® account.

The main navigation consists of:

• Profile Icon Menu
• Side-pane navigation (Notifications is the only option)
• Action buttons
• Notifications Data-table
• Data Table Actions
• Notification Information/Editing
• Notification Bulk Editing

Profile Icon Menu

The Profile Icon Menu is accessed by clicking on your profile picture in the top right of the screen. If you do no have a picture, you will see a circle with your initials inside. This menu has three (3) options and is used for finding support, accessing the about information, and signing out of the application.

Profile Menu Options

• Help center - links to support and documentation.
• About - build and acknowledgements information
• Sign out - sign out and close the current session of the application.

Side Pane Navigation

Notifications plus will only have one option present here (Notifications) and this will potentially expand as new features and functionality are requested.

Action Buttons

The Action buttons are the primary means to interact your notifications and create new notifications. The New Notification button is ready to be engaged immediately but the other actions require selecting a notification before they become available.

To engage the other actions buttons simply select which notification you would like by clicking the empty box to left of the Notification name. Now the Actions buttons will become available and are ready to be engaged.

• New Notification  
• Duplicate
• Simulate
• Bulk Edit
• Delete

Notifications Data-table

The data-table contains all relevant information about the notifications you create. All notifications you generate within this application will be displayed here. Here you can see relevant info, turn on/off notifications quickly, and use the the Action buttons  to edit and bulk edit multiple notifications at once.

Data-table Actions Icons

To the upper right of the data-table, in-line with Action buttons, are the Data-table Action Icons. These are quick functions related to the data table data and provide functions like: row or card view, filtering, exporting and toggling statues for all notifications quickly.

Notification Information/Editing

To the upper right of the data-table, in-line with Action buttons, are the Data-table Action Icons. These are quick functions related to the data table data and provide functions like: row or card view, filtering, exporting and toggling statues for all notifications quickly.

Notification Bulk Editing

To the upper right of the data-table, in-line with Action buttons, are the Data-table Action Icons. These are quick functions related to the data table data and provide functions like: row or card view, filtering, exporting and toggling statues for all notifications quickly.

This menu has three (3) options and is used for finding support, accessing the about information, and signing out of the application.

Profile Menu Options

• Help center - links to support and documentation.
• About - build and acknowledgements information
• Sign out - sign out and close the current session of the application.

Data-table columns:

• Name - the name of this notification and clicking will go into edit mode for that notification.
• External Number - the external number that will engage the notification action.
• Direction - call direction that triggers the notification.
• Delivery Method - which delivery methods does the notification utilize.
• Created Date - date the Notification was created.
• Status (on or off) - is the notification engaged or not and will it trigger if conditions are met.

Sort by Data-table Column

To change which column is sort and by which order, click the name and of the column you would like to sort to cycle through these options:

• Descending (first click)
• Ascending (second click)
• no sort (third click)

Your notifications will be displayed by most-recent order unless you choose to sort by one of the data-table columns.

Overflow Icon

Each notification as an Overflow Icon (three vertical dots) that will open ip with a drop down that presents two options that will either delete or duplicate this notification.

Overflow Icon Options

• Edit - edit or modify this notification.
• Duplicate - duplciate this notification.

This menu is intended as shortcut so you do not have to select the notification, and then the action, to duplicate quickly.

Data-table pagination

At the bottom of the data-table you will see the pagination elements. To the left is the page display that allows you to select a page and to the right is the rows per page and total count of notifications.

Page Display

Here you can quickly view all pages of the data-table by with clicking on a page number, or clicking on of the buttons displayed to the right or left of the numbers.

Page display actions:

• First Page - go to the first page.
• Previous page - go to the previous page.
• Next Page - go to the next page.
• Last Page - got to the last page.
• Blank page box - when you have more than 3 pages, an empty page box will appear. Simply enter the page number you want to visit and click outside the box to engage.

Rows per page

Click to change the amount of items displayed per page. Options are:

• 5
• 10
• 20
• 30
• 40
• Show All

Entries

Displays the total amount of notification items present for your account.

The New Notification button is ready to be engaged immediately but the other actions require selecting a notification before they will become available.

To engage the other actions buttons simply select which notification you would like by clicking the empty box to left of the Notification name. Now the Actions buttons will become available and are ready to be engaged.

Here are all the Actions Buttons:

New Notification

Create and configure a new notification.

Duplicate

Duplicate one, or more, existing notifications.

• Click the checkbox next to a notification, or multiple notifications, then click Duplicate to engage.

Simulate

You can use the simulate feature to test any notification you have configured without actually triggering the notification.

• Click the checkbox next to a notification then click Simulate to engage.
• One may only select one notification to Simulate at a time.

Bulk Edit

Change the direction or external number for multiple notifications at once.

• You must select two or more notifications for this option to become available.
• Click the checkbox next to two or more notifications and then click Bulk Edit to engage.
• You can ONLY change the External Phone Number and Direction for multiple notifications with the Bulk Edit action.

Delete

Delete one, or more, notifications.

• Click the checkbox next to a notification, or multiple notifications, then click Delete to engage.
• Consider toggling the Status of a notification before deleting it if the notification simply needs to be in-active temporarily and not permanently.

Change View

Change the view to be either a data table with rows and columns or cards in a grid pattern.

• Grid icon when you are in Data-table mode (default view).
• Three horizontal lines icon when you are in Grid mode.

Filter

Filter the Data in the data-table by searching for keywords or by Direction or Status.

• When engaged, a grey space will open between the data table columns and the Action Buttons and Data Table Icons.
• Click Type keyword to search and start typing to search by keyword or variable.
• Click the dropdown for Direction and/or Status to choose one or more options to filter by.

Export

Export the data-table as an XLSX file with ALL data entries.

• If you select one or more notifications and hit export, it will only export that notifications data.

Toggle All

Quickly toggle the Status for all notifications.

• Commonly used when needing to update or re-configure many notifications without them triggering in the process of the update.

Warning: This will disable all notifications when triggering to off Status. Make sure you want to do this before engaging.

The notification details section is broken down into several steps to help guide you through the creation and editing process. Once you have filled in all required details, you will be able to review and then simulate your notification.

Use the 'Next', 'Back' buttons to navigate through the steps as you complete them. You must complete the current step to move to the next step in the Notifications details area.

These sections steps are:

• Name
• Phone number
• Direction
• Trigger
• Delivery
• Review

Creating a new notification

There are two ways to create new notifications: clicking the 'New Notification' button or by duplicating one or more existing notifications.

New Notification

To create a new notification, simply hit the button labeled 'New Notification' in the data table actions section.

Note: You may only create one notification at a time with the 'New Notification' button.

Duplicate existing notification(s)

You can duplicate one or more existing notifications to create several new notifications at one time. This is an efficient process when the details might slightly differ between several notifications; like the phone number or call directions.

How to Duplicate Notifications:

• Select two or more notifications you would like to duplicate by checking the box in front of the name.
• Once two or more notifications are selected, the Bulk Edit button will highlight and become available.
• Click the 'Bulk Edit' button and edit the details to re-configure the duplicated

Note: This is most commonly used in combination with Bulk Edit to then edit the notifications after a duplication to handle creating many new notifications at one time.

Read about 'Duplicate' in the data table actions section for more info.

Edit a notification

Edit an existing notification

To edit an existing notification, simply click the  name of the notification, if in data table view, or the card if in card view. You will then see the notification details for that specific notification.

Note: It is possible to edit multiple notifications at once. Read more in the Bulk Editing section to learn about the advantages and limitations of Bulk Editing notifications.

Notification Details

The Notification Details contains all the information to make your notification active and trigger on the conditions you specify. Please see all the details below and complete all necessary steps to create or re-configure your notification.

Name

The desired name for this notification. Choose something that will help distinguish it from other notifications you may create.

When you are finished entering a name, click the 'Next' button to proceed to the 'Phone Number' section.

Phone Number

The external phone number that, when called from your RingCentral® account, will trigger this notification. You will choose which call direction in the next step.

The phone number field has a country code dropdown but you may also post the number plus the country code and hit (tab) or click outside the field for the next button the highlight.

Note: You do not need to insert the (+) plus symbol with your phone number when entering the phone number with the country code. Simply click outside the field or hit Tab for the (+) plus symbol to be added automatically if not included already.

Direction (Phone Call Direction)

The call direction determines which call flows that will initiate a trigger condition.

The options are:

Inbound

When a call comes from the specified phone number into your RingCentral® account.

Outbound

When a call comes to the specified phone number from your RingCentral® account.

Both directions

Both Inbound and Outbound are active. If the specified phone number calls into, or is dialed to from your RingCentral® account, the notification will trigger.

Triggers

The trigger is where you will identify which call objects can trigger this notification (e.g. what users/extensions or sites will trigger this notification when calling the specified phone number from above).

Toggle the trigger switches to enable the different Trigger configurations, as you can use a combination of any of the three options once they are active.

Note: Users is on by default but you can toggle it off at any moment. Just make sure to have one option toggled one or you will not be able to proceed.

Users

Users is the most common trigger condition and is easy to understand.  If the specified user(s) have outbound/inbound calls to the specified external phone number, the notification will trigger.

You may select individual users from the dropdown to build a list of users that will trigger this notification when conditions are met from other settings.

All users is any user in your RingCentral® account, including you.

You may remove an already added user by hitting the 'X' icon in the badge next to the user's name.

Note: 'All Users' is toggled on by default, but you may select a user to turn it off or toggle the switch.

Extension Pattern

When a particular extension meets the specified pattern, and they have an outbound/inbound call to the specified external phone number, it will trigger the notification.

The extension patterns that are recognized by the application and that can be used are below:

• Wild Card - Use an asterisk as wild card for any number,  e.g. 6****. In this example, if any extension starting with six(6) meet the other conditions, the notification will trigger.
• Range - Use a dash (-) between two numbers to select all extensions within the range of the two numbers. E.g. 6000-9000. Entering 6000-9000 would give you all numbers between 6000 and 9000 for all total of 3000 extensions that will trigger when conditions are met.
• Single Extension number - Enter a single extension number, like 6789, that will trigger the notification when conditions are met.
• Comma to separate multiple Extension patterns - Use a comma (,) to separate several extension patterns to map a more complex extension pattern that might be required for your needs. E.g. 5****, 6000-9000, 9101 would include all extensions that start with 5, any extension between 6000 and 9000 (3000 extensions) and the single extension of 9101, for a total of 3001 + how many extension that start with a 5 in your account (probably a lot!).

Note: Notice when clicking into the field, the extension pattern examples appear within the field box to help guide you in creating an efficient pattern to trigger your notification.

Site Extensions

When extensions (e.g. a users) assigned to specified site(s) have outbound/inbound calls to the specified external phone number, it will trigger the notification. You may add one or more sites that trigger the notification.

You may remove an already added site by hitting the 'X' icon in the badge next to the site's name.

Delivery

The delivery section gives you four (4) options for how you can receive the notification after all conditions are met. You may select all options or create a custom configuration of your own, but all fields must have details if they are enabled, to proceed.

Notification Delivery options:

• Email - Send the notification message via email. You can specify one or more addresses with a comma (,) separating each email.
• Webhook - Send the notification via a web hook. Please enter the full web address including the 'https://' or 'http://' at the beginning of the address.
• Glip® - Send a notification to one or more Glip® Teams. Select which team by typing or via the dropdown or create a new Glip® Team by clicking 'New Team'.
• Adding a new Glip® Team to Glip Delivery Option - Click 'New Team', Add the Team name, add users by typing and selecting via dropdown and switch this Team to private or keep it public depending on your preference. Click 'Create Team' to create and choose as a delivery option.  
• SMS - Add one or more phone numbers, with the country code, that will receive the message content via SMS text message. Usage and international rates SMS rates apply. https://support.ringcentral.com/article/International-SMS.html

Delivery Message Content and Message Snippets

The message content area contains the text that will be delivered to the delivery option(s) you choose when the notification is triggered. Click in the Message content field and begin typing, or select one or more of the four (4) Pre-built Message Snippets on the right side of the message content container.

The Message Snippet options are there to add helpful information quickly and they are:

• Timestamp - the time when the notification was triggered.
• Emergency Address - the emergency address of the extension that met the trigger condition.
• Extension Number - the extension number of the extension that met the trigger condition.
• Extension Name - the extension name (user name) of the extension that met the trigger condition.

Review

This section shows all the settings for a particular notification so you can review how it functions before making changes or before finalizing a new notification.

Make sure all setting meet your desired configuration and hit the 'Save' button to finalize and create new notifications, or to save changes you have made to existing notifications.

Note: Use the 'Simulate' feature after editing or creating notifications to see if the notification delivery method and message are what you intended. This way you can ensure the notification is configured correctly without an actual trigger event taking place (like a test call to 911).

Bulk edit existing notifications

The Bulk Edit feature allows you to edit multiple notifications at once and change direction or phone number for the selected notifications.

This allows you to edit or re-configure several notifications in a fewer actions and create new notifications based on existing notifications, very quickly and efficiently.

Another common technique is using duplicate to create new notifications from an existing one, and then using the Bulk Edit on the new notifications to adjust the settings more quickly than traditional single-notification creation.

Note: When duplicating notifications, we need to edit the details after duplication or switch off the duplicated notifications if they are not being Bulk Edited at the moment and still match the original notification. This ensures we do not get duplicated notification deliveries for one trigger event.

How to Bulk Edit multiple notifications

Bulk edit multiple notifications by following the steps below.

Select two or more notifications

• Select the notifications you would like to duplicate by checking the box in front of the name.

Click Bulk Edit

• Once two or more notifications are selected, the Bulk Edit button will highlight and become available.
• Click the 'Bulk Edit' button and edit the details to re-configure the duplicated

Edit Details in Bulk Edit Modal

• Change the phone number.
• Change the call direction, if needed.
• Click 'Edit'.

Note: This is most commonly used in combination with Duplicate to then edit the notifications after a duplication to handle creating many new notifications at one time.

Read about 'Duplicate' in the data table actions section for more info.

• Bulk orchestration of IVR prompt media across multiple IVR’s.
• Schedule and combine prompts to start/end on a specific date/time.
• Tag IVR names with custom values to group and filter by business-specific logic for easier bulk editing.
• API integration to your RingCentral media library and IVR’s.
• Customizable role-based access and granular permissions control.

Getting Started

Log in to IVR Orchestrator using your RingCentral® credentials at the following URL:

https://ivrorchestrator.ps.ringcentral.com

Your RingCentral account administrator will need to enable access to this application for the role of your RingCentral user (see the Users section of this document).

New accounts automatically receive a free 14-day trial period upon first login. After the trial period expires, you must contact your Account Executive or Sales Representative to purchase a subscription for your account.

IVR

The IVR section of this application displays a list of all IVR’s present in your RingCentral office account. The list of IVR’s can be filtered to create a group that can be used to scope bulk management operations. Toggle between IVR prompts for both business hours and after hours.

IVR prompts can be applied to IVR's immediately on an individual basis or in bulk, or they can be scheduled for deployment at a specified start/end date/time. Clicking on the name of any IVR in the data table will allow you to see the prompt media currently in use for the IVR as well as any upcoming scheduled prompts.

This application takes the scheduled prompt media and combines it with the default prompt media into a single audio file that can be dynamically managed and deployed to the RingCentral Office platform for each IVR.  Scheduled prompts are played in the order you specify and the default prompt media is heard last.

Scheduling Prompts

Scheduling a prompt allows you to define a start and end date and time during which the prompt should be active.  You may schedule up to (5) additional prompts in addition to the default prompt media.

• Be aware when scheduling prompts across IVR’s in different time zones or site time formats (12h or 24h). For example, if you are bulk editing IVR’s across both the central and mountain time zones to schedule a prompt, and specify 3pm as the start time, that will get scheduled as 3pm central time and 3pm mountain time (no localization is performed).

Optional Naming Convention

IVR’s using the optional naming convention described below are further recognized by this application. These values are used to create custom columns in the IVR section data table that allows for grouping/filtering based on unique business-specific logic.

Use the following pattern when naming your IVR’s inside of the RingCentral service portal to take advantage of this feature:

ivrname-key1:value1,key2:value2,key3:value3,key4:value4,key5:value5

(64) character maximum, including spaces and punctuation. You may specify up to (5) custom key:value pairs separated by commas.

Each key:value pair represents an individual column in the IVR section data table. The key is the column heading and the value is the cell content. For example, you may have stores organized by state, region, district, etc. This could modeled using the following the IVR naming convention example:

mainStoreIVR-state:CO,region:12,district:4

This allows bulk operations to be executed across user-defined datasets, for example changing the IVR prompts on all stores/locations in region 12.

Media

Media refers to the actual audio files that callers hear when interacting with an IVR. The media section of this application displays a list of all media present in your RingCentral Office account. You may also add new media and remove existing media.

MP3 and WAV file types are supported. Multiple files can be uploaded simultaneously (bulk upload).

This section is fully integrated to the media library in your RingCentral Office account:

• Media imported into this application will appear in the RingCentral account media library.
• Media added directly to the RingCentral account media library will appear in this application.
• Deleted media will be removed from both this app and the RingCentral Office account media library.

Any media that is present can be used for orchestration activities across a single or multiple IVR prompts.

Users

The users section allows you to define which roles from your RingCentral Office account will have access to this application and what permissions the users having those roles will be granted. It also shows what users from your account have logged into the application.

A list of all roles present in your RingCentral Office account is automatically populated into the roles section. Enable a specific role with permissions to give its users’ access to this application.

The built-in super admin role is hardcoded with permanent RW access to avoid the potential of accidentally getting locked out. A user with a super admin role on the RingCentral account must perform the initial role-enablement for other users this application.

Permissions can be set for each existing role. You may grant read-only or read-write access to each individual section of this application to any given role.

VPN Cloud Relays:

Generally, the timeline to complete all steps below is about 4-6 weeks after the signed SOW is received by the PS Development team. This is highly dependent on how much time the customer requires to configure and deploy their "half" of the VPN tunnels.

1. RingCentral Advanced Solutions Architect team works with customer to identify and qualify Cloud Relay requirements.
2. PS Development team validates any new design requirements from ASA team, SOW/Change Order is created for customer.
3. PS Project Manager sends fully-signed SOW/CO to PS Development team.
4. PS Project Manager provides link below to customer for review and completion of our "AirTable Cloud Relay survey".
   a. Survey link to share with customer: https://airtable.com/shrmw0jl8ToHsCxXZ
   b. If the integration to the customer's application requires a site-to-site VPN, they need to select "Yes" to question #5 regarding the VPN, so all of the additional VPN-related questions load on the survey.
   c. One survey should be completed for each unique application that we'll be integrating to.
5. Once AirTable survey (step 4) has been fully completed and submitted by customer, PS Development team moves the Cloud Relay project into their deployment queue (deployment usually takes ~10 business days after survey is received and reviewed).
6. PS Development team deploys Cloud Relay into their AWS Account, and configures all VPNs using information from AirTable VPN Survey. Securely shares VPN configuration files with customer, so they can deploy and connect their side of the VPNs.
7. PS Development team works with customer to turn-up and test all VPN tunnels, verify connectivity to customer server(s).
8. PS Development team creates Postman collection + Grafana dashboard with customer-specific data, hands off to PS Implementation Manager to begin writing and testing custom scripts, as defined in SOW/CO.
9. PS Implementation Manager completes custom scripting/integrations, schedules review and 'go live' for Cloud Relay integration with the customer.
10. PS Project Manager follows up with PS Development team to notify when Cloud Relay portion of project is complete and live in customer environment.

Summary:

The RingCentral Cloud Relay is designed to act as a relay between two systems that cannot natively exchange information with one another.

Cloud Relay will 'translate' (or just relay) the messages from the source system and send them to the relay-target/destination.

Use Cases:

• #1 - Customer/3rd party HTTP endpoint requires SOAP messaging; Cloud Relay can be used to translate REST messages from RingCentral to SOAP.
• #2 - Customer/3rd party HTTP endpoint requires a site-to-site VPN to connect to them.
• #3 - Customer/3rd party HTTP endpoint requires certificate-based authentication; Cloud Relay can provide the certificate in each request from RingCentral to the customer/3rd party system. We can also load up to 4 certificate based on the destination endpoints.
• #4 - Customer/3rd party HTTP endpoint requires IP whitelisting/allowing only a small number (2-4) of public IP addresses to connect to their public API, rather than all of the RingCentral supernets.
• #5 - Transform messages from XML to JSON. The CR will accept json, transform it to xml, then transform the response back to json. Request must pass header "Accept: application/json" to activate xml -> json transformation, or else the ClouRelay will still respond with xml.

Cloud Relay AWS API Endpoints:

• GET /ping: returns pong if Cloud Relay-specific credentials are set correctly via HTTP headers. Use to verify x-api-key and x-api-secret values, and connectivity to the Cloud Relay API Gateway(s).
• POST /apisecret: used to rotate the value of x-api-secret as required. New value should be sent in the body, using secretKey as the key, and the new secret as the value.
• ANY /{proxy}: replace {proxy} with the remote API URL that should receive the requests.

Required HTTP Headers included in each Cloud Relay:

• x-api-key: static value, per AWS API Gateway, used to control which requests are accepted.
• x-api-secret: can be rotated programmatically via the /apisecret endpoint. This can help satisfy certain security and compliance regulations.
• relay-target: value contains the URL of the remote server that Cloud Relay will relay the request to.
  - If your API endpoint has additional resources at the end of the URL, set relay-target as the base URL, and append the resource string to the end of the request URL.
  - EG: if your API endpoint is: https://google.com/api/users/tyler
  - relay-target = https://google.com
  - Request URL = https://{{uswest_apigw}}/api/users/tyler
  

Target endpoints:

• Public IP : supported without customization.
• Private IP : supported without customization.
• Public FQDN : supported without customization.
• Private FQDN : Customer need to provide a DNS server that can be reach from the cloudRelay, this also require a Custom CloudRelay.

Example diagram using Cloud Relay to connect to customer's on-prem SymXchange system:

When numbers are added they become available for assignment to users, sites, etc. Numbers entered when creating users and sites are automatically added to the Numbers section for you.

• Numbers added to the workspace are automatically carrier "dipped" to verify portability to RingCentral (currently supports the North American +1 country code).
• International numbers (anything outside of the +1 country code) are placed into the "International" group. You can assign temps and see the mapping assignments for international numbers, but they must be manually submitted via a separate international porting process.

Conductor supports port-in and temporary phone numbers.

• Port-in phone numbers are the real phone number the user will eventually use (once it has ported to RingCentral).
• Temporary numbers are ephemeral and only used until porting has completed. Temporary numbers are typically used for forwarding to maintain continuity for the customer during porting.

Adding Numbers

There are three ways to add phone numbers:

1. Using the Add Number button.
2. Bulk uploading a list of numbers.
3. Attaching the numbers to users or sites when you create or edit them (they will automatically show up).

Add Number Button

The Add Number button will let you add numbers manually. Engage the Add Another button in the modal when saving to make it easier to enter multiple numbers in quick succession (or bulk upload a list of numbers).

Bulk Uploading

You can bulk upload a list of numbers in excel or CSV format to your workspace. These numbers will be identified as Company numbers when uploaded because they are not yet linked to any specific object.

These numbers can now be assigned to users or sites when creating or editing them.

Number Assignment

Once numbers have been added, the Assigned To column is used to identify what object this number is linked to in the workspace. There are three possible values:

• Site is a port-in phone number that belong to a specific site.
• User is a port-in phone number that belongs to a specific user.
• Company is a port-in phone number that will be stored in the account as an extra company number rather than being associated with a specific user.

Number States

Numbers have several states to help identify their status. These statuses can also be viewed in the badges above the data-table. The first badge, Total, simply shows how many numbers are in the workspace.

• Dipping - the number is currently being dipped.
• Error - the number could not be carrier dipped, or is not portable.
• Ready - the number has been dipped and is ready to port.
• Porting - the number is currently porting or inside a port package.
• Ported - this number has been ported over to RingCentral.
• International - the number cannot be dipped and will be placed into a special carrier group.

Carrier Groups

Conductor automatically categorizes numbers into different carrier groups by common losing carrier.

• Additional system groups may be seen (e.g. All Numbers, Errors and International) and are not grouped by the identified carrier but by different standards.
• Create your own custom carrier groups to further organize your numbers for porting, for example when phased porting activities across multiple sites are required (you decide what carrier groups are included in a given porting package).

Carrier Group Types

As mentioned, there are two types of carrier groups (in addition to the system groups above):

• Conductor-Generated Carrier Groups are automatically generated as numbers become identified by the system.
• User-Created Carrier Groups can be created by selecting numbers from within a Conductor-generated carrier group and then hitting the New Group button. Conductor automatically adds a sequentially incremented ID number to the user-created carrier group name to help identify it as a user-created group. You can move numbers from the Conductor-generated carrier groups into user-created carrier groups as needed.

Note: You can only make user-created carrier groups from a selection while inside of a Conductor-generated carrier group.

Group Details

The group details for each carrier group contain the information required in order to generate an LoA form for the carrier group. You must provide these required fields before you can submit the port package that the group belongs to. If these details are not provided accurately, your port request may be rejected and could delay the go-live date of your customer.

Providing Carrier Group Details

To edit the details of a group, navigate to one of the groups by clicking on its badge above the data-table and then hit the Group Details buttons to provide the required information:

• Company name or Individual* The name of the company or individual who is authorizing this porting request to RingCentral.
• Authorized person to make request is only required if a company name is present in the "Company name or Individual" field above. If it is a person in the field above, please leave blank.
• Copy of current telecom bill* a copy of the customer's current telecom provider bill as required by the porting team. Max upload limit is currently 5MB.
• Phone #* is the BTN or "billing telephone number" for the numbers that are part of this group.
• Account number is not required but some carriers might require it for a port request. Please try to locate the account number if possible.
• PIN same as the account number, not required by default but some carriers might need it. Please try to locate the account PIN number if it exists.
• Service address* please enter if different from the pre-populated site address. The pre-populated address is the most common address found among these numbers.

(*) denotes a required field

When you complete all the required fields within a carrier group's details, the carrier group will display a green circle with a check over its badge.

Porting and the LOA Document

The group details are used to generate the necessary LoA documents for each carrier group being included in a porting package. Use the porting queue to generate the required LoA's for your customer to sign.

Learn more about porting on the porting queue page.