Introduction
OneXtel is a leading Communication Platform as a Service (CPaaS) provider that offers seamless, end-to-end communication solutions. OneXtel offering includes channels such as SMS, Voice, WhatsApp, Chatbot, Rich Communication Services (RCS), and Email services tailored for businesses of all sizes.
library_add_check |
Prerequisites
|
Configure OneXtel as a Custom SMS Connector (Service Provider)
This article will help you configure OneXtel as a Custom Connector.
Log in to the MoEngage Dashboard and perform the following steps:
- Navigate to Settings -> Channel -> SMS -> Sender configuration.
- Click + Add Sender at the top right corner. The Add sender page is displayed.
- In step 1 "Service Provider", click + Add custom service provider. The Add Custom Connector sender page is displayed.
- Add the following details in step 2 "Sender Details":
Field Description Mark as default Turn this toggle on to mark the sender as the default sender for the service provider being configured. If marked as default, this sender will be used for sending all SMS campaigns from MoEngage unless you select a different sender while creating the campaign. Service provider name This field identifies the service provider you are configuring on the MoEngage Dashboard and has to be unique. Enter “OneXtel”. Sender name This field identifies the sender. For example, OneXtel SMS or Aura SMS.
Sender type Select the sender type. Available options are:
- Transactional: Select this option to use the sender for sending alerts about transactions, OTPs, security information, or any information that can be classified as transactional in nature.
- Promotional: Select this option to use the sender for sending information about your brand, promoting deals, or engaging with users.
- Configure the Webhook by adding the following details:
- Using GET as the HTTP method:
Field Description API URL
This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The GET API URL for OneXtel is:
https://api.onex-aura.com/api/smsMethod
Select GET as the HTTP method.
URL Parameters
Add the URL Parameters to be passed to the API as Key-Value pairs using this option.
Key Value key Enter the API Key. entityid
Enter the Entity ID. from
Enter the Sender ID corresponding to the SMS type. to
Enter "Moesms_destination". body
Enter "Moesms_message". templateid
Enter "Moesms_dltTemplateId". Headers
The Headers section remains unchanged in this case.
- Using POST as the HTTP method:
Field Description API URL
This field contains information about the URL that should be used to send an API request to the Sender. You can get this information from the API Documentation of the Sender. Type the API Endpoint of the sender here. The POST API URL for OneXtel is: https://api.onex-aura.com/api/jsms
Method
Select POST as the HTTP method.
URL parameters
The URL parameters section remains unchanged in this case.
Headers
Content-Type will be filled as application/json automatically as you enter the POST API URL of OneXtel.
Body type
Select the body type as either JSON or Raw.
- Refer to the following table if you select the Body type as JSON:
Key Value body
Enter "Moesms_message". entityid
Enter Entity ID. from
Enter Sender ID corresponding to the SMS type. key Enter the API key. templateid
Enter "Moesms_dltTemplateId". to
Enter "Moesms_destination". - Refer to the following JSON body if you select the Body type as Raw:
{
"key":"Enter API Key",
"body":"Moesms_message",
"to":"Moesms_destination",
"from":"Enter Sender ID corresponding to the SMS type",
"entityid":"Enter Entity ID",
"templateid":"Moesms_dltTemplateId"
}
- Refer to the following table if you select the Body type as JSON:
- Using GET as the HTTP method:
- Click Send test SMS to verify your configuration.
- Click Save to save the sender configuration.
Create an SMS Campaign
- On the MoEngage Dashboard, go to Segment > Import Users to add recipient details.
- Once recipients are added, from the MoEngage Dashboard, click Engage > Campaigns. The All campaigns page is displayed.
- Click + Create campaign.
- Under Outbound, click SMS and select the SMS Campaign type as One Time, Periodic, or Event Triggered based on your requirement. For more information about delivery types, refer to Delivery Types. The SMS creation page is displayed.
- Enter the campaign name and select the target audience among your user list. Click Next.
- Enter the DLT approved template ID and message. A preview of the message will be displayed on the right side of the screen.
- It is highly recommended to test the campaign before making it live. In the Test Campaign section, add a phone number, and click Test. Click Next.
- Under the Send campaign section:
- To send immediately, select As soon as possible.
- To send at a preferred date and time, select At specific date and time and set start date and send time.
- Click Publish.
Delivery Tracking
You can configure delivery tracking after creating the sender in the MoEngage Dashboard. For information about Delivery Tracking, refer to Delivery Tracking in Custom Connectors.
info |
Information To configure Delivery Tracking, send an email to the OneXtel Support team at support@onextel.com sharing your API key and the SMS delivery tracking URL of MoEngage: https://api-01.moengage.com/sms/dlr/custom/1598820387. |
Sample Response from OneXtel
For a Successfully Sent Message
For a Delivered Message
Mapping Delivery Response
Select the fields from Delivery Response to auto-populate the response mapping fields, as shown below:
Click Save to save the delivery tracking configuration for the custom connector.