Getting Started with your Restcomm Organization
Overview
The Restcomm Console is designed to support a service provider’s daily business monitoring processes and make it easier to keep track of their enterprise customers activity.
In this guide, you will learn how to use the Restcomm Console’s main features to setup your Restcomm organization, bring your own carrier, whitelabel the console, create applications, clients, phone numbers, check calls and message logs, and recordings.
Set Up Your Restcomm Organization
Restcomm Login Interface
To access the login interface, make sure you use the correct Restcomm Organization URL that you have defined when you were registering your Restcomm account (the URL you received in the sign up confirmation email). It should look like https://{mydomain}.com/login
Restcomm Console
This is the default page you will see after you log in. Here you can find the latest news about Restcomm, new features announcements, as well as usage overview of your account activity.
Whitelabel Your Restcomm Console and Bring Your Own Network (BYON)
Once you have logged in your Restcomm account, you can brand your console by following the steps in the whitelabeling guide. In addition, you can also, bring your own network.
Restcomm Account Settings
To access your account settings, click on the drop down representing the name of your account then navigate to Account at the top right corner of the window, as shown in the screenshot below. You will be able to:
-
Retrieve your Account SID and Auth Token, which are required in order to use the Restcomm API to place Outbound Calls or send SMS by example.
-
Retrieve your Account Information such as First Name, Last Name, Email, Role.
-
Change your Account password
-
Create Sub-Accounts.
All of the information presented visually under the Restcomm Account Settings is also accessible through the Restcomm Accounts API
Get Started with Restcomm Applications
Restcomm Applications
This section allows you to create, delete, update and search your Restcomm Applications. When you are first logging into the workspace, you will see two types of applications split in two sections: Your Applications also known as Visual Designer applications and Turnkey Applications.
Visual Designer Applications
This type of applications are built on the top of the Restcomm Visual Designer user interface. You can choose from a list of prebuilt applications available in the Template Gallery or create one on your own.
To access the Visual Designer applications, navigate to the top of your screen and click on Applications → Your Applications.
Create Visual Designer Application
To create a new application, click on the Add New App button on the right corner of the screen. You will be prompted to choose between three way of creating an application.
-
Create a Visual Designer Application: Build a Restcomm Visual Designer Application which will be hosted by Restcomm and will contain the logic of your application to be executed upon receiving a call or a message. Visual Designer is a quick and great way to create Voice and Messaging applications with minimal or no programming skills. This option will let you define a name and the type of application (Voice or SMS). This choice is the quickest to get started and you can already choose from a list of existing templates covering popular application use cases.
-
Import a Visual Designer Application: Lets you import a pre-existing Restcomm Visual Designer Application which will be hosted by Restcomm and contain the logic of your application to be executed upon receiving a call or a message. Visual Designer is a quick and great way to create Voice and Messaging applications with minimal or no programming skills. This option will let you define a name and the type of application (Voice or SMS).
-
Create a URL Application: This option allows you to create a RCML Application which will be hosted externally, outside of Restcomm and will contain the logic of your application which will be executed upon receiving a call or a message. The REST Communications Markup Language needs to be used to design your application. You will need to define a name, URL of the RCML application hosted outside of Restcomm and the type of application (Voice or SMS). This is the longest way to get started and requires a good understanding of how Restcomm works, To get started quicker, create a Visual Designer Application instead.
Turnkey Applications
The Turnkey applications are robust, scalable, real-time time applications that leverage the power of the Restcomm APIs. With the help of those you can onboard new customers quickly, monitor their daily activity and generate meaningful reports that help you stay on the top of your business. The Turnkey Application Gallery lets you choose between a wide variety of applications.
To access the Turnkey applications, navigate to the top of your screen and click on Applications → Turnkey Applications.
Enter Your Turnkey Application
To start using a Turnkey application, simply click on the Enter button as shown below. You will be redirected to the corresponding Turnkey application web console.
To learn more about this type of applications and their capabilities, please check out the Restcomm Turnkey Applications Documentation.
Restcomm Numbers
Create, delete, update and search your numbers. When your first log into Restcomm Console, this section is empty. Future updates to the platform will list a set of demo numbers to get you started quickly. This section also allows you to link a Number to an Application created in the previous section.
Register a Number
When you click on the Register Number button, you will see a screen similar to the screenshots below. This will allow you to create a new phone number that can be attached to a Restcomm application. You can register two types of Numbers:
-
SIP Number: These numbers are virtual numbers which are not tied to any Origination PSTN Provider. They can be reached via a registered Restcomm Client using SIP or WebRTC. Type the name of the SIP Number you want to create in the SIP Address field. Make sure you are entering a name you can easily remember in the Friendly Name field at the top of the screen. Click on the Register button, which will lead you to the Edit Number section. Then link your newly purchased number to a Restcomm application.
-
Provider Number: These are numbers tied to an Origination PSTN Provider and can be reached via a landline or mobile phone as well as through a registered Restcomm Client using SIP or WebRTC. You need to first search for a number from the Provider in order to purchase. That requires you to select a Country from the dropdown, an optional Number as an additional filter in case you are looking for a specific number pattern. Optional capabilities (SMS or Voice), and optional type (Landline, Mobile, Toll-Free) can be also applied as additional search filter. Click on the Search icon. And then choose from the list the number of your choice. Click on Register Number. You will then be redirected to the Edit Number section below to link your newly purchased number to a previously created Restcomm application.
Edit/Update a Number
Editing a Restcomm Number can be done after a purchase or creation or by clicking on the number in the Numbers list. The screenshot below shows how you can edit a SIP Number but is also applicable for a Provider Number. You can set or update the Voice or SMS Application to which the number is bind to.
You have two options for binding the application to a number:
-
Application: You can use the dropdown list to select one of the applications previously created with Visual Designer
-
RCML URL: You can use this field and paste the URL to your externally hosted RCML Application
In addition to that, you can also set the RCML URL to link to another Application under the advanced list menu. Click on the Advanced link to see more options for both SMS and Voice Applications.
-
Voice or SMS Fallback URL: The RCML URL that Restcomm will request if an error occurs retrieving or executing the Application set previously.
-
Voice or SMS Callback URL: The URL that Restcomm will request to pass status parameters (such as call ended or SMS delivered) to your application.
-
Voice REFER URL: The RCML URL that Restcomm will request when receiving a SIP REFER request to this number. Read the Restcomm REFER Tutorial to learn more about Restcomm support for REFER.
Restcomm Clients
Restcomm lets you create, delete, update and search your Restcomm Clients. When you initially start with Restcomm, this section has a default Client which you can use. Its username and password are the same as our Restcomm Account credentials. A Restcomm Client is an abstraction for storing credentials related to a typical SIP or WebRTC (using SIP Over Websockets) endpoint that can be uses through traditional SIP Softphone or hardphone or through our Restcomm WebRTC SDKs (Currently in Preview)
Restcomm Logs
The log section gives you an overview of all inbound and outbound Restcomm calls or sent and received SMS.
Call Logs
A list of all calls that have been received or sent by Restcomm. This section will be empty until you make or receive any calls to a Restcomm number.
Call Details
If you click on any call details in the list, you will be able to see the full details of the call including its status and if there is a recording link to it , that can be downloaded.
Recordings
A list of all Recordings (using the Record Verb) that have been received or sent by Restcomm. This section will be empty until you record any calls with Restcomm.
