Internal: Setting up Custom Domain Link Shortening
This document provides detailed steps to configure a custom domain for link shortening in the Meera platform using a client account.
Link to the doc on shared drive
Note: The Link Shortening feature is only available for use with Messaging Services (will not work for Toll Free Numbers Alone)
Steps to Access the Custom Domain Section on the Client Profile Page
If You Are Logged in as a Client:
- Login: Use the client's credentials to log in to the system.
- Navigate to Profile Page: Once logged in, go to the Profile page.
- Scroll Down: Scroll down to the Custom Domain section.
- Manage Domains: Here, you can add, edit, or manage custom domains.
If You Are Logged in as an Admin:
- Login: Use your admin credentials to log in to the system.
- Go to Client Tab:
- Locate the Sidebar menu and click on the Client tab.
- This will display a list of all clients.
- Search for the Client:
- Use the search bar to find the specific client you want to set up a custom domain for.
Click on the client to view their profile page.
- Access Profile Page:
- Once on the client’s profile page, scroll down to the Custom Domain section.
Manage Domains: Add, edit, or manage custom domains for the client.
1. Add a Domain from Client Account
- Click on Add Domain
- Navigate to the domain settings page and click the "Add Domain" button.
- Select Link Shortening
Choose Link Shortening as the domain purpose.
-
- For link shortening, use the recommended subdomain format: ls.domainname.
2. Configure the Subdomain
- Select Subdomain
Enter the subdomain (ls) and the client’s domain name.
- Proceed to Configuration
- Click Continue to move to the configuration step.
- Click Continue to move to the configuration step.
There are two options for further setup:
- Self-Created Link Shortening Subdomain
- Forward Login Steps to Client
Option 1: Self-Created Link Shortening Subdomain
If the client has the credentials or will configure the subdomain themselves:
- Provide Credentials
On the next step, the client must enter their domain credentials to proceed.
Complete the verification process as prompted.
3. Subdomain Configuration
Once verified, the system displays a message: "Your subdomain is configured and will be live within 48 hours."
Add the following DNS entry in the domain’s records:
Type: CNAME
Name: ls
Value: lsct.ashburn.us1.twilio.com.
TTL: 600 seconds
Option 2: Forward Login Steps to Client
If the client will complete the registration process independently:
- Share the Registration Link
- After adding the subdomain and domain value, select the "Forward Login to Client" option.
Copy the shared link or check the Share Link box, then click OK.
Add the client’s email address to send them the registration details.
3. Client Registration Steps
-
- The client will receive an email with a link to complete the following:
- Log in
- Perform authentication
- Finalize the configuration process
After the client completes the steps, the subdomain will be configured within 48 hours.
- Check DNS Records
Add the following DNS entry in the domain’s records:
Type: CNAME
Name: ls
Value: lsct.ashburn.us1.twilio.com.
TTL: 600 seconds
Fetch Client Status
To track whether a client has completed the registration steps, a webhook can be implemented.
Note: The webhook integration is part of the premium plan and requires additional add-ons. Once implemented, it will allow tracking the status of client registration using the domain or userId. This feature is available only for premium and enterprise tiers
4. Add the Domain to Twilio Account
Create and Verify Domain:
Use the Twilio Console to manually create and verify a domain. After completing the process, retrieve the Domain SID from the Domain details page. (Note: This process cannot be automated via API.)
- Collect the Domain SID for the requested domain from the client's Twilio account.
- In the client's account, go to the Custom Domain section and request an SSL certificate for the respective domain by adding the Domain SID and saving it. This will forward the request to Twilio to generate the SSL certificate.
After SSL Approval:
- Once your SSL request is approved, you will be able to use the short links for the domain you requested.
- Configure the short link settings in the Twilio Console as needed to align with your use case.
Enable link shortening for messaging services using Twilio
Note: The Link Shortening feature is only available for use with Messaging Services
(will not work for Toll Free Numbers Alone).
Steps to Configure
- Domain Configuration:
- Add a DNS record of Twilio IP or CNAME to the domain provider.
- Provide the configured domain details to Vivek Sir for integration with Twilio.
- Request the Domain SID from Twilio after setup.
- We can manage SSL directly from the console also.
- Activation of Link Shortening:
- Via API:
Once the Domain SID is received, activate link shortening for the messaging service through the API.
Via Campaign UI
Navigate to the Campaign List in the application.
- Select the campaign you want to activate link shortening for and click the Edit option.
Steps in the Campaign Edit Page
Go to the Connectors tab.
- Click on the Link Shortening tab.
- From the domain selection dropdown, choose the domain you want to use for link shortening.
- Select the domain you want to associate with the messaging service for the campaign.
- Click the Update button.
By simplifying the process, link shortening is now directly managed through the Connectors Tab. This eliminates the need for a separate section on the edit page.
Post-Update
- After the update, link shortening will be activated for the specified messaging service ID.
- All links for this messaging service and campaign will now be automatically shortened using the selected domain.
- Via Console:
- Open Twilio Console and navigate to Messaging > Messaging Services.
- Select the desired Messaging Service to configure.
- In the left navigation pane, select Link Shortening.
- Under Organization and Domain, choose the link-shortening domain from the dropdown.
- Save changes.