Integrate MoEngage for SMS (Generic SMS Plugin)

message your customers by sending a single sms or starting an sms broadcast using exotel's generic plugin on moengage to complete the integration and enjoy seamless communication, follow the steps below step 1 upload your dlt compliance details in exotel to send an sms, the dlt mandate requires the following information configure these in the settings section of your exotel dashboard entity id entity id is the unique id provided to your business sender id the sender id which will be used to send the smses template id template id is the unique id for each transactional or promotional sms that you wish to use template details upload the dlt approved templates for the messages you would like to send to your customers sms type sms types are used to classify different types of messages as per the purpose, e g transactional, service explicit, service implicit, and promotional step 2 keep your exotel dashboard information handy find your account sid, api key, and api token on dashboard > settings api https //my exotel com/exotel/apisettings/site#api credentials exotel dashboard api settings showing the account sid, api key, and api token find your sender id on dashboard > settings api > sender id https //my exotel com/exotel/settings/site#dltentity settings exotel dashboard sender id settings find your entity id on dashboard > settings api > sms dlt settings https //my exotel com/exotel/settings/site#dltentity settings exotel dashboard sms dlt settings showing the entity id find your dlt template id on https //my exotel com/exotel/settings/site#sms settings https //my exotel com/exotel/settings/site#dltentity settings exotel dashboard sms settings showing the dlt template id step 3 configure the connector in moengage on the moengage dashboard https //dashboard 01 moengage com/v4/#/auth , go to settings > channel > sms and connector click on sms connector config under sms and connector settings under custom connectors , click on create moengage sms connector configuration screen fill in the requested details general details connector name exotel will be selected here by default sender name write a name for the configuration to uniquely identify it api url enter the below http api endpoint https //\<subdomain>/v1/accounts/\<your sid>/sms/send json replace \<subdomain> with api exotel com if you access exotel via my exotel com, enter api in exotel com if you access exotel via my mum1 exotel com replace \<your sid> with your account's sid (refer to step 2 for this) select the api type as post from the dropdown url parameters keep url parameters empty for this configuration headers key authorization value add the 64 bit encoded token here you can follow the below methods to access the 64 bit token option 1 login to https //web postman co https //web postman co and create an api request select the method as post enter the below http api endpoint https //\<subdomain>/v1/accounts/\<your sid>/sms/send json replace \<subdomain> with api exotel com if you access exotel via my exotel com, enter api in exotel com if you access exotel via my mum1 exotel com replace \<your sid> with your account's sid (refer to step 2 for this) under the authorization tab, click on basic auth enter the api key in the username enter api token in password postman basic auth configuration with the api key and api token click on send click on the \</> icon which is near the send button you will see a curl request with the basic authorization token take the value of the token to use in the moengage configuration postman code view showing the curl request with the basic authorization token option 2 drop an email to hello\@exotel com mailto\ hello\@exotel com to get your basic authorization token body type select "form" as the body type from select the sender id to send the sms from (refer to step 2 for this) to customer's number who will be receiving the sms enter moesms destination as the value for this field to set up the configuration body body of the sms which will be sent to the customer enter moesms message as the value for this field to set up the configuration key keep this field empty for this configuration step 4 send a test sms to ensure that the integration is working as expected, you can send a test sms by clicking on send sms to test in the dialogue box presented, enter these details, then hit send test country code and mobile number to which you would like to send the message message enter a sample message which you would like to test eg this is a test message powered by exotel report abuse to +918088919888 exotel moengage send sms to test dialog step 5 start using the plugin now that your sms plugin is ready, you can use it to send sms to customers configure delivery callbacks once the sms configuration is saved, you would be able to configure delivery callbacks which would push the sms delivery information to moengage from the exotel side these callbacks would be used to display the sms campaign success and details about the sms deliverability with delivery percentage and errors step 1 configure the delivery callback url follow the below steps click on delivery tracking copy the sms delivery tracking url as shown below moengage delivery tracking screen showing the sms delivery tracking url click on +kv pair under body type enter statuscallback in the key and paste the delivery tracking url copied in step 2 above in the value field step 2 map desired attributes/fields in the delivery response you can either map the fields from the delivery response or map the fields manually by choosing the desired option this mapping helps moengage to understand the custom connector's delivery response we prefer you use the map fields via delivery response to map the fields from the delivery response click send test sms choose the country code and mobile number to which you want to send the test sms and add a test message click send once you receive a success message, you can see the following message on the dashboard it may take up to 15 minutes to receive the delivery callback information once moengage receives this information, it will be shown in the dashboard you can map the fields from this response the dropdowns are auto populated with the field names parsed from the delivery response the first image shows a sample sms delivery response, and the image below shows the auto population of the dropdowns from this response for mapping on the dashboard in case you are not able to receive the response automatically, please check your api url; it must contain " json" at the end for example https //\<subdomain>/v1/accounts/\<account sid>/sms/send json select the callback fields as below field value unique sent id field smsmessage sid unique delivery id field smssid delivery status field detailedstatus success values for delivery status delivered to handset failure reason field detailedstatus refer to the below screenshot for mapping the fields moengage delivery response field mapping screen once the above is done, test the settings by creating a test campaign and observe the campaign performance from the campaigns tab under engage create a campaign by referring to create sms campaign – user guide https //help moengage com/hc/en us/articles/360061107151 create sms campaign#target audience 0 0 and choosing the configuration created in step 3 as the provider you can also refer to configure sms custom connector – user guide https //help moengage com/hc/en us/articles/360061107691 configure sms custom connector#step 2 configure web hook 0 1 for more details on configuring the sms connector please connect with the moengage team to set up throttling (eg 100 rpm) for the sms connector to make sure the campaign runs successfully refer to push throttling – user guide https //help moengage com/hc/en us/articles/205604289 push throttling#throttling at the campaign level 0 0 for more details need help? if you have any questions or concerns, please connect with us using the chat widget on your exotel dashboard or whatsapp us on 08088919888