Get Started with RCSBusiness Platform
TThe RCS Messaging Platform is a tool for businesses to communicate with their customers using Rich Business Messaging (RBM). RBM allows for richer, more interactive text-message systems. It includes features like phonebook polling for service discovery, multimedia transmission, and action links. Set up an RCS Business Account through EnableX to take full advantage of these advanced messaging capabilities and enhance your messaging experience. This guide will walk you through every step of setting up and optimizing your RCS Business Account with EnableX.
Request for RCS Service
To use the RCS business messaging API through EnableX, you will need to submit a service request on our platform.
- Navigate to RCS in the left menu bar.
- Select Request in the resulting menu.
- If you want to begin with RCS Business Messaging APIs, Click on I WANT RCS FOR BUSINESS.
- A Request Submission pop up will confirm your request.
Setup RCS Business Account
Setting up a RCS Business Account with EnableX allows you to take advantage of a range of powerful features. Once you have submitted the request, EnableX's support team will contact you to gather any required information and documentation to get you started with RCS Business Account Registration Process. They may also provide guidance on the setup process and answer any questions you may have about using the API effectively.
Add RCS Service into your Project
To use RCS Business API, you need to use RCS as a Service into your Project. To have RCS added into a Project, you may follow either of the following ways:
- You can create a new Project as add RCS as a service.
- If you already have a project, you can add RCS as a Service in it.
Create a new RCS Project
Follow either of paths given below to create a new project to add RCS Service in it:
Path# 1
- Navigate to My Dashboard.
- Go to My Projects section.
- Click on CREATE PROJECT button.
- This will take you to a new Form;
- Enter the project-related information like project name, application and project description.
- Enable RCS in the Channels section.
- Once you have filled in all the necessary information, click on CREATE PROJECT button to create your project.
- A popup of successful project creation will appear on your screen. To move further into process, click on GET STARTED button within the popup.
- If the project creation process fails, review the previous page and ensure that all mandatory fields are completed.
- you can add more services to it by going to the My Projects section.
Path# 2
- Navigate to My Dashboard.
- Go to Left Menu Bar and select RCS.
- Navigate to the **My RCS Projects **section.
- Click on CREATE PROJECT.
- This will take you to the same Create Page form as explained in Path# 1.
- Follow the same process as explained.
Add RCS to existing Projects
This process involves a few simple steps to configure your RCS integration within your existing projects.
- Navigate to My Dashboard.
- Go to My Projects section.
- To add services to a project, select the project you want to modify and click on the Edit icon. This will open the project summary page.
- Select EDIT PROJECT.
- You reach an EDIT PROJECT form using which you can add new services to the Project or remove any existing service.
- Enable RCS option and then click on SAVE CHANGES.
Add RBM Agent and Display Name for RCS Project
Each EnableX RCS Project must have an RBM Agent linked to it.
Note: The RBM Agent will be created by the EnableX at the time of your RCS service request fulfilment. You will be asked for the necessary documentation and information for your RBM Agent. The details provided by you will then be reviewed, and if appropriate, your Agent request will be approved by the admin.
To add an RBM Agent, follow the given path:
- After creating a new project, you will be taken to the project summary page.
- Navigate and click on the RBM Agent tab.
- It will take you to the RBM Agents page. Click ADD RBM AGENT.
On the Add RBM Agent page,
- Select the registered RBM Agent from the dropdown list.
- After selection, the associated Display Name for that Agent will display.
- Click LINK TO PROJECT to add the Agent to your project.
- A confirmation popup will confirm your RBM Agent linking
- You can view your RBM Agent details on the MY RBM Agent page.
You can continue further to setup Webhook against your RBM Agent where notifications and incoming messages will be posted by our RCS Service.
Manage RCS Project
After setting up your RCS Business account on EnableX and getting a registered RBM Agent linked to your Project, it is time to effectively manage your RCS project. This involves gaining access to app credentials, configuring phone a webhook, creating and managing your messaging templates, and tracking performance metrics.
Get API Access Credentials
A Project's API Access Credentials are sent by Email when a Project is created. However, you may need to reset API Key or resend API Credentials. Follow these steps to get your project's access credentials reset or resend.
- Navigate to the RCS DASHBOARD, select the project you want to work with, and then click on the Action icon.
- This will take you to the Project Summary page.
- Look for the Project Credentials block in this page.
- Locate the SEND CREDENTIALS and** RESET APP KEY** buttons.
- If necessary, use the RESET APP KEY option to reset the application credentials.
- Use the SEND CREDENTIALS option to resend the application credentials to your registered email address.
Setup Webhook for Notification and Incoming Message
A webhook is setup against each registered phone numbers to receive notifications and incoming messages to that phone number. Follow these steps:
- Navigate to the RCS DASHBOARD, select the project you want to work with, and then click on the Action icon.
- This will take you to the project SUMMARY page.
- Select PHONE NUMBER tab. It will show phone numbers registered for this project.
- Click on the Action icon against the a registered number and then select Set Up Webhook on the resulting pulldown menu.
- This will take you to Setup Webhook to receive instant Notification page in a popup.
- Enter a Webhook URL to receive incoming messages and messaging-related notifications.
- Enable** HTTP Authorization** if your Webhook URL is HTTP Basic Authentication protected. Enter Username and Password for your Webhook Access.
- Click on SAVE.
Note:
- The Notification URL entered here must support POST request.
- Ensure that the Webhook URL is hosted on HTTPS and supports keep-alive.
- Webhook URL must acknowledge each post with a response of HTTP 200 header. Read more
Create and Manage Message Templates
The Message Template Tab will only appear once your RBM Agent is added to the project. This is necessary to ensure that your RCS Business account is fully set up before you begin creating message templates. An RCS Template is a predefined set of RBM UI elements, such as a Rich Card with suggestions, used as a foundation for crafting messages in your campaign to the target audience. Each project can have only one RBM Agent linked to one message template category (OTP, Promotional, or Transactional). Once the RBM Agent is added to the project, the brand can develop multiple templates within that category for the selected RBM Agent. These templates can be of any type: text message, Rich Card, or Rich Card Carousel.
Guidelines for Template Content
List of Templates
below are the list of templates:
- View the list of Message Templates and their status by clicking the MESSAGE TEMPLATES tab.
- Use filter options to search for templates based on Status, Phone number or by Category then Click **APPLY **to get a filtered list.
- Note that templates with APPROVED status can only be used for Business Initiated Conversation.
Create New Template
To create a new template:
- Click on the ADD TEMPLATE tab.
- A page appears with the ADD TEMPLATE form.
- Select and enter the required details and click on PROCEED.
- Enter your Template Name. It must be within 20 characters.
- Select the Template Type (Text, Rich card, or Carousel).
- Select the predefined Agent for the project.
- Enter Body according to the Type.
- Add Suggested Actions as required.
Suggested Action
Note: RBM supports 4 buttons with 3 categories:
- Reply: 25 character limit.
- Dialer: 25 character limit.
- URL Action: 2048 character limit.
Simple Reply: With just Reply buttons in it (25-character limit).
URL Action: You can provide a URL which should not exceed 2048 characters.
Dialer Action: Include phone number with country code.
Note: Buttons can be with the same categories or a mixture of them.
Template Type - Text
If you select Text as a template type, a Text Message Body opens.
- Enter the text message body. Add variables if required in square brackets.
Note: The character limit for a text message is 2500. If the content includes only 160 characters, then it will be considered a Basic message; if it exceeds 160 characters, then it will be considered a rich message.
Template Type - Rich Card
If you select Rich Card as a template type, a Card form opens.
- Variables: In a Rich Card, you can add an 'n' number of variables (in title and description fields) within the character limit.
- Card Title: Add title for your rich card. It is a mandatory field and the character limit for this is 200.
- Card Description: Add description of the rich card. The character limit for card description is 2000.
- Media Height: Download the template guidelines for image resolutions.
- Card Orientation: Rich card can be oriented vertically or horizontally.
For Horizontal Card Orientation, select alignment:
Alignment | Image Ratio | Image File Size | Video File Size | Media Thumbnail | Resolution (Pixels) | Format |
---|---|---|---|---|---|---|
Left/Right | 3:4 | 2MB | 10MB | 250x330 pixels (Vertical), 770x335 pixels (Horizontal) | 768x1024 pixels | JPEG, JPG, PNG, or GIF |
For Vertical Card Orientation, select Media Height:
Media Height | Image Ratio | Image File Size | Video File Size | Resolution (Pixels) | Format |
---|---|---|---|---|---|
Short | 3:1 | 2MB | 10MB | 1440 x 480 pixels | JPEG, JPG, PNG, or GIF |
Medium | 2:1 | 2MB | 10MB | 1440 x 720 pixels | JPEG, JPG, PNG, or GIF |
After adjusting your rich card elements, select your suggested actions and click PROCEED.
Template Type - Carousel
If you select Carousel as a template type, a Carousel form opens which has two card forms. RBM allows a minimum of two cards and a maximum of 10 cards in a Carousel. For now, EnableX sets a limit of maximum 6 cards.
- Variables: In a Carousel, you can add an 'n' number of variables (in title and description fields) within the character limit for individual cards.
- Card Title: Add individual titles for your rich cards. It is a mandatory field and the character limit for one card title is 200.
- Card Description: Add individual descriptions of the rich cards. The character limit for one card description is 2000.
- Card Width: Set your cards' width. It could be small or medium.
- Media Height: Set your cards' heights. It could be short or medium.
- Media Type: Set your cards' media type. It could be an image or a video. Upload media or provide a media URL.
Card Width | Media Height | Image Ratio | Image File Size | Video File Size | Resolution (Pixels) | Format |
---|---|---|---|---|---|---|
Small | Short | 5:4 | 1MB | 5MB | 960 x 720 pixels | JPEG, JPG, PNG, or GIF |
Small | Medium | 4:5 | 1MB | 5MB | 576 x 720 pixels | JPEG, JPG, PNG, or GIF |
Medium | Short | 2:1 | 1MB | 5MB | 1440 x 720 pixels | JPEG, JPG, PNG, or GIF |
Medium | Medium | 4:3 | 1MB | 5MB | 1440 x 1080 pixels | JPEG, JPG, PNG, or GIF |
After adjusting your Carousel elements, select your suggested actions and click PROCEED.
- After successfully submitting your message template request, you will receive a pop-up notification confirming the submission.
- All submitted templates will appear as PENDING for approval. It mostly takes a few seconds for a Template Approval. However, approval time may vary and depends on RBM’s review process.
- The Template List will show the updated status.
Get Reports
With reporting features from EnableX, you can access both conversation and message reports for your RCS interactions. These reports provide valuable insights into your performance metrics, customer engagement, and billing and payment details. To access these reports, simply navigate to the Reports section of the RCS menu in your EnableX account
Get RCS Conversation Report
You can gain valuable insights into your RCS conversations, which provides real-time and historical data on customer interactions, approximate charges, and more.
- Navigate to My Dashboard.
- Go to Left Menu Bar and select RCS.
- Select Reports from the dropdown menu.
- Select CONVERSATION tab.
- Choose the Agent you wish to generate a report for from the available dropdown, **Country **and Date Range and click on EXPORT.
Get RCS Message Report
Track the success of your RCS messaging, which offers detailed performance metrics on sent and received messages, delivery rates, and more.
- Navigate to My Dashboard.
- Go to Left Menu Bar and select RCS.
- Select Reports from the dropdown menu.
- Select MESSAGES tab.
- Choose the Agent you wish to generate a report for from the available dropdown, Country and Date Range and click on EXPORT.