SMS Integration
- 22 Feb 2024
- 2 Minutes to read
SMS Integration
- Updated on 22 Feb 2024
- 2 Minutes to read
Article Summary
Share feedback
Thanks for sharing your feedback!
A user object is required to collect and process users’ phone numbers and SMS opt-ins. Because Insider does not store any personal data on cookies or local storage, you must integrate a user object using Insider Object to gather the information necessary to send SMS.
Your title goes here
If you want to collect leads directly from your website, you should implement Insider Object integration to pass the opt-in information to Insider. Instead, you can use Insider's lead collection templates.
The following describes how to integrate user objects for SMS using Insider Object.
Sample code for SMS user object
window.insider_object = {
"user": {
"phone_number": "+120394879878",
"gdpr_optin": true,
"sms_optin": true
}
}Namespace
The code of Insider Object is as follows:
window.insider_object.*Code for user objects must be added under code for Insider Object.
User objects for SMS: Properties, definitions, and code
User object includes the user properties. User object can be implemented in all cases, including when the user is not logged in. When the user is not logged in, only the available properties will be filled in; keys without values will not be added to the object.
| Key | Property | Type | Definition |
|---|---|---|---|
| phone_number* | Phone Number | String | User's phone number in E.164 format (e.g. +6598765432) |
| sms_optin* | SMS Opt-in | Boolean | User's permissions for SMS. True = SMS allowed; False = SMS not allowed |
| gdpr_optin* | GDPR Opt-in | Boolean | User's permissions to recieve Insider campaigns, or have their data collected and processed. False = User does not see Insider campaign or receive messages from any channel; True or empty = Insider can interact with user through personalized campaigns |
* Required field for this object.
If your company obtains your users' consent in compliance with the local regulations, make sure to pass the GDPR opt-in field to Insider. If you want to stop collecting and processing the data of an identified user, GDPR opt-in field should have the false value. Insider cannot be held liable if these obligations are not fulfilled and reserves the right to seek compensation from your company.
Once the user object is integrated into your website, you can provide Insider with the required sms fields (phone_number, sms_optin, gdpr_optin) whenever a user logs in.
Note: sms_optin must be true for Insider to send users SMS. Insider always assumes users have opted out of SMS. We will not send users any SMS until directed to do so by the partner.
Your title goes here
If you passed the user’s uuid information while implementing the Insider Object, make sure the information is the same for both. For more information on uuid on user objects, see Insider Object Integration.
Checklist for any page where user object is present:
- Object window.insider_object.user returns on the page.
- All properties are filled in when user logs in
Was this article helpful?