White Labeling

Overview

Restcomm enables you to go to market with your own CPaaS brand in a matter of days. Restcomm provides a set of white-labeling capabilities such as: custom UI, styling of your organization, custom domain, and even an option for white label documentation .

In addition to branding, Restcomm enables you to bring your own network assets such as SIP Trunking, telephone numbers and termination routes for voice and SMS.

Branding your Restcomm account

Restcomm can be customized using the branding option under your account settings. This feature lets you set your company name, logo, favicon, support and documentation URLs, terms and conditions, your custom domain, and styling.

General Organization settings

To begin the white-labeling process, log in to your Restcomm account, navigate to Account → Settings → Your Brand.

In the General Organization settings form:

  • Enter the name of your organization

  • Upload your company logo (with minimum required size of 75 x 75 px).

    • Your company logo will be displayed on the top left corner of the Console, Visual Designer, WebRTC demo and your white-labeled documentation user interfaces.

  • Upload your favicon (with required size of 16 x 16 px or 32 x 32 px)

  • Background image for your Console sign in page (optional).

    • The background minimum required size is 1920 x 1080 px.

  • Provide a link to your documentation (optional).

    • Make it easier for your users to get started by sharing your documentation page with them.

    • If you do not have your own documentation, you can choose to go with the default one or display no documentation link. Notice that because the documentation is generated dynamically, if you change this setting the search engines might take a while to index the new content.

  • Specify your company website and product name.

  • Add a link to your terms.

Let users know what your terms and conditions are and how they can utilize your services by linking them here.

General organization settings

Setting up your custom domain

Custom domain is a way to create branded links, e.g. mycompany.restcomm.com, that help you identify your brand. Restcomm allows you to set your own custom domain using the Restcomm Console interface.

You can move past the section below if you do not want to use a custom domain. Otherwise, follow these steps.

In order to use your custom domain with Restcomm, you will need to:

  • Provide a valid certificate obtained by a trusted third party organization (like GoDaddy)

    • You should provide a full chain certificate in PEM format, that obtains Root CA and intermediate CAs

  • Make changes in your CNAME and SRV DNS records

Setting up your CNAME

CNAME overview

A CNAME is a DNS record that allows users to specify that a domain name is an alias — or an alternate name — for another domain.

Through the use of a CNAME, you can change your Restcomm Cloud domain from yourcompany.restcomm.com format to a custom name that fits your company’s online presence and helps you create a unified brand experience. This means that you can host Restcomm to a subdomain such as rest.yourcompany.com.

First, you must configure a CNAME record with your domain host. You will likely need to work with your internal technical support team to help you create a custom configuration of your company domain.

Your hosting provider should provide step-by-step instructions for adding a CNAME record to your domain’s DNS settings. These steps are unique for each provider and if you are not familiar with the process, it is best to search their documentation or reach out to their technical support team. You will also need to map your CNAME to your Restcomm domain (for example apis.restcoinexchange.com to cloud.restcomm.com).

Once that is done, you can log in into your custom domain by visiting rest.yourcompany.com or using the API as follows:

curl -X GET  \https://<AccountSid>:<Auth Token>@apis.restcoinexchange.com/restcomm/2012-04-24/Accounts/<AccountSid>
Setting up your SSL certificate

If you decide to use a custom domain, you will need to obtain a valid SSL certificate. This is important because while the Restcomm data and login information is always transferred over a secure connection (HTTPS), a certificate is required for the Restcomm URL to be displayed under HTTPS when using a custom domain.

To get your certificate, navigate to your SSL provider’s website and download the certificate. You need to get two .crt files (a “Certificate body” and “Certificate Chain”) and a .pem (“Private Key”) file.

See it in action

To access your custom domain, you can use the following curl command. Make sure to replace restcoineschange.com with your custom domain name.

curl -X GET  \https://AC9cbb219fb1fe7:8e2491ae0cdb020d37c979f69bed1186@apis.restcoinexchange.com/restcomm/2012-04-24/Accounts/AC9cbb219fb1fe7400ef365a38b282b286

and log in to https://apis.restcoinexchange.com/#/login with your Restcomm organization username and password.

SIP/WebRTC Custom Domains

DNS/SRV Records overview

A Service record (SRV record) is a specification of data in the DNS defining the location, i.e. the hostname and port number, of servers for specified services. It is defined in RFC 2782. Some Internet protocols such as the Session Initiation Protocol (SIP) and the Extensible Messaging and Presence Protocol (XMPP) often require SRV support by network elements and allow for DNS Failover and Load Balancing.

You must configure DNS SRV records with your domain host. You will likely need to work with your internal technical support team to create a custom configuration of your company domain.

Your hosting provider should provide step-by-step instructions for adding DNS SRV records to your domain’s DNS settings. These steps are unique to each provider and if you are not familiar with the process, it is best to search their support documentation. You should map your DNS SRV Records to reach our network and therefore will need to configure your DNS SRV Records similar to the ones below:

_sip._tcp.<your custom domain>. SRV 0 5 5060 <PoP specific SIP domain, like ‘eusip’>.restcomm.com
_sips._tcp.<your custom domain>. SRV 0 5 5061 <PoP specific SIP domain, like ‘eusip’>.restcomm.com
_sip._tls.<your custom domain>. SRV 0 5 5061 <PoP specific SIP domain, like ‘eusip’>.restcomm.com
_sips._tls.<your custom domain>. SRV 0 5 5061 <PoP specific SIP domain, like ‘eusip’>.restcomm.com
_sip._udp.<your custom domain>. SRV 0 5 5060 <PoP specific SIP domain, like ‘eusip’>.restcomm.com

Once you have completed these steps, you can return to the Custom Domain section in the Restcomm Console and populate the form below:

Setting up your custom domain

Setting up your custom styling

The Custom Styling section allows you to apply your styling to the Restcomm Console, Visual Designer, WebRTC demo and white-labeled documentation.

Here are the styling options you may use:

  • General styling options

    • Background color

    • Primary tabs background color

    • Primary tabs text color

    • Primary card background color

    • Secondary card background color

  • Text styleing options

    • Basic text color

    • Discrete text color

    • Links text color

    • Warning text color

  • Controls styling options

    • Primary button background color

    • Primary button text

    • Danger buttons background color

    • Danger buttons text color

    • Default buttons background color

    • Default buttons text color

    • Input background color

    • Input placeholder text color

    • Borders color

    • Borders radius

  • Documentation styling options

    • Voice section title color

    • SMS section title color

    • RCML section title color

Setting up your custom styling

If you wish, you can leave the custom styling values set to defaults or specify new ones.

Once done, click Save to apply your changes.