Introduction
telSpiel offers enterprise communication services including SMS, WhatsApp Business Messaging, RCS, Voice & Email. With the MoEngage and telSpiel SMS Integration, you can communicate with your end users for the following:
- Bulk SMS communication of different categories – Promotional, Service Implicit, and Service explicit.
- Real-Time Delivery updates
In addition, you can also automate sales and marketing engagements by sending personalized texts through a secure SMS Platform.
Integration
| library_add_check |
Prerequisites
|
To configure telSpiel as a Custom SMS Connector, perform the following steps:
- On the MoEngage dashboard, navigate to Settings > Channel > SMS.
- On the SMS tab, click Add SMS Sender.
- Click Add custom service provider.
- Add the following details in the Sender Details screen:
Field Description Sender Type Select Sender Type - Promotional/Transactional based on SMS account at telSpiel. Connector Name Enter the Connector Name for the SMS Connector to uniquely identify it. Example: "telSpiel" Sender Name Enter Sender Name (DLT Approved Header) API URL Select the GET or POST option depending on which HTTP Endpoint you have from telSpiel.
Now Enter the telSpiel SMS Push Endpoint (GET/POST) with respective credentials/details:
GET API:
Endpoint for Single API request:https://api.telsp.in/pushapi/sendmsg?username=xxxxxx&dest=xxxxxxx&apikey=xxxxx&signature=SENDERID&msgtype=TypeofMessage&msgtxt=template&entityid=entityIdvalue&templateid=templateIDvalue&custref=uniquereferenceid&hashId=dltChainvalue
Endpoint for Multiple API request:https://api.telsp.in/pushapi/sendbulkmsg?username=xxxxxx&dest=xxxxxxx,xxxxxxx&apikey=xxxxx&signature=SENDERID&msgtype=TypeofMessage&msgtxt=template&entityid=entityIdvalue&templateid=templateIDvalue&custref=uniquereferenceid&hashId=dltChainvalue
Key-value pair: Enter your keys and values.
POST API:
Endpoint for Single API request:https://api.telsp.in/pushapi/json/sendmsg
Endpoint for Multiple API request:https://api.telsp.in/pushapi/json/sendBulkMsg
Enter the JSON payload structure supported by the POST Endpoint.Parameter Details Key value pair / Json Parameter details: -
username=<******>[telSpiel api username] -
dest= Moesms_message[Mobile no. on which SMS to be sent] -
apikey= User account Authentication keyprovided by telSpiel signature=DLT approved Header/Sender-
msgtype=Type of message(PM for plain text or UC for Unicode message/multilingual message) -
msgtxt= Moesms_destination[DLT approved message text] entityid=DLT Entity ID Value-
templateid=Template ID Value[DLT template id against approved template] -
custref=Reference unique ID(optional) -
hashId=Dlt chain Value(optional)
Headers For POST Endpoint, please enter below key-value pairs:
Key:Content-Type| Value:application/json
Key:Accept| Value:application/jsonBody Type (Only for POST) For POST Endpoint, select “Raw” and Enter the entire JSON payload structure:
JSON
For Single request: -
For Multiple request: -{ "username":"xxxxxx", "apikey":"xxxxxxxxxxx", "msgtype":"TypeofMessage", "msgtext":"Template", "signature":"SenderID", "entity":"EntityIDValue", "templateid":"TemplateIDValue", "tag":"CampaignNameGivenByUser”, //OPTIONAL "custref":"Uniquereferenceid”, //OPTIONAL "hashId":"DltChainvalue", //OPTIONAL "dest": ["xxxxxxxxx"] }{ "username":"xxxxxx", "apikey":"xxxxxxxxx", "entity": "xxxxxxxx", "msgtype": ["xx","xx"], "signature": ["xxxxx","xxxxx"], "msgtext": ["Template1","Template2"], "templateid": ["TemplateIdValue1","TemplateIdValue2"], "tag": "CampaignNameGivenByUser", //OPTIONAL "hashId":"DltChainvalue", //OPTIONAL "custref":"Uniquereferenceid", //OPTIONAL "dest": ["xxxxxxxx","xxxxxxxxx"] }Delivery tracking For Delivery tracking, after saving the “Custom Connector” edit it. Now select the option “Map fields manually” and do the below mapping: - Unique sent ID field:
uuid - Unique delivery ID field *:
uuid - Delivery status field *:
status - Success values for delivery status *:
DELIVERY_SUCCESS - Failure reason field *:
description
-
- Click Save.
Troubleshooting
If any issue occurs while sending a test message or saving the configuration, follow the steps below:
- Ensure that the telSpiel Endpoint and respective parameters/JSON structure are added correctly, as they are case-sensitive.
- If the issue persists, raise a Support Request to MoEngage to get your error code.
- Connect with the telSpiel support team to get the issue resolved after you receive the error code from the MoEngage Support team. Support Email: care@telspiel.com.