<< Click to Display Table of Contents >> Navigation: Table of Contents > Converse Desk > Object/Data Model |
SMS-Magic Interact enables 2-way communication with your contacts. In addition to sending text, you can include other media such as audio and video. Salesforce Custom Objects are used to to enable and store the conversations.
These are the primary objects used by the SMI application.
•SMS History
•Incoming SMS
•SMS Templates
•SMS SenderID
•MMS Detail
This document provides detailed information about these objects.
All outbound and inbound messages that you exchange with your contacts are stored in this object.
These are the fields that store information about the message.
Label |
API Name |
Purpose |
Account |
smagicinteract__Account__c |
This field stores ID of a related account record. |
Campaign |
smagicinteract__Campaign__c |
This field stores ID of a related campaign record. |
Case |
smagicinteract__Case__c |
This field stores ID of a related case record. |
Contact |
smagicinteract__Contact__c |
This field stores ID of a related contact record. |
Conversation |
smagicinteract__Conversation__c |
This field stores ID of a related Conversation record. |
Converse App |
smagicinteract__Converse_App__c |
This field stores ID of a related Converse App record. |
Converse App Action |
smagicinteract__Converse_App_Action__c |
This field stores ID of a related Converse App Action record. |
Converse App Task |
smagicinteract__Converse_App_Task__c |
This field stores ID of a related Converse App Task record. |
Delivery Error Message |
smagicinteract__Delivery_Error_Message__c |
This field stores the error message if there is a problem with the delivery. |
Delivery Status |
smagicinteract__deliveryStatus__c |
This field stores the delivery status i.e. Failed, Success of the message. |
Direction |
smagicinteract__Direction__c |
If single object is enabled then this field states the message type incoming or outgoing. |
Disable SMS On Trigger |
smagicinteract__disableSMSOnTrigger__c |
This field decides if the message should be delivered or a message record should only be created. Set 0 to deliver and 1 for record creation. |
External Field |
smagicinteract__external_field__c |
This is an identifier for external systems like SMS-Magic backend. They use this field to push back delivery status. |
Favourite |
smagicinteract__Favourite__c |
This field tells if a particular message is favorite or not. |
Lead |
smagicinteract__Lead__c |
This field stores ID of a related Lead record. |
Message Credits |
smagicinteract__SMS_Credits__c |
The field states the number of credits used by this message. |
Message Type |
smagicinteract__Message_Type__c |
The field tells the type of message i.e. SMS or MMS. |
MMS Subject |
smagicinteract__MMS_Subject__c |
This field stores the MMS subject. |
Mobile Number |
smagicinteract__PhoneNumber__c |
This field stores the mobile number of the recipient. |
Name |
smagicinteract__Name__c |
This field stores the name of the recipient. |
ObjectType |
smagicinteract__ObjectType__c |
This field stores the name of the object where recipient data is stored. |
Opportunity |
smagicinteract__Opportunity__c |
This field stores ID of a related Opportunity record. |
Previous Message |
smagicinteract__Previous_Message__c |
This field stores ID of previous message. |
Response |
smagicinteract__response__c |
This field stores the response given by the provider. |
SenderId |
smagicinteract__SenderId__c |
This field stores the Sender ID used to send the message. |
Sent By |
smagicinteract__Sent_By__c |
This field stores ID of the user who has sent the message. |
Sent On |
smagicinteract__Sent_On__c |
This field stores the date, time when message was sent. |
Sent Status |
smagicinteract__sentStatus__c |
This field tells if the message has been received by the SMS-Magic backend when sent from Salesforce. |
SMS Template |
smagicinteract__SMS_Template__c |
This field stores ID of a related template record. |
SMSText |
smagicinteract__SMSText__c |
This field stores the text delivered to the recipient. |
Source |
smagicinteract__Source__c |
This field stores the feature used to send the message. |
Status Message |
smagicinteract__statusMessage__c |
This field states the failure reason if the message is not received by the SMS-Magic backend. |
Text Unicode |
smagicinteract__Is_Text_Unicode__c |
This boolean field states if the message is Unicode or not. |
Type |
smagicinteract__Type__c |
This field stores the type of message outgoing or incoming. |
Unformatted Phone Number |
smagicinteract__Unformatted_Phone_Number__c |
This field stores the unformatted version of the mobile number. |
Use Default Sender |
smagicinteract__Use_Default_Sender__c |
This picklist field tells the Sender ID used belongs to record owner or current user. |
User |
smagicinteract__User__c |
This field stores ID of a related Opportunity record. |
This object is created when sending an MMS to your contacts. This object contains a master-detail relationship with SMS History. For each MMS that is sent, a record of MMS Detail is created.
Label |
API Name |
Purpose |
SMS History |
smagicinteract__SMS_History__c |
This field stores ID of a related outgoing sms record. |
MMS Type |
smagicinteract__MMS_Type__c |
This field stores the MMS URL type. |
MMS URL |
smagicinteract__MMS_URL__c |
This stores the MMS URL. |
In previous versions of SMS-Magic, all incoming responses were stored in this object. If you are upgrading from past versions, we recommend you to switch to SMS History object to store all your messages.
You can ask the SMS-Magic support team to change the setting to store inbound messages in the SMS History object—or can continue using this object. Though it will still be available, this object will remain as-is and no future enhancements will be made to it.
These are fields of this object.
Label |
API Name |
Purpose |
actionTaken |
smagicinteract__actionTaken__c |
This field stores ID of a related account record. |
Campaign |
smagicinteract__Campaign__c |
This field stores ID of a related campaign record. |
Case |
smagicinteract__Case__c |
This field stores ID of a related case record. |
Contact |
smagicinteract__Contact__c |
This field stores ID of a related contact record. |
Conversation |
smagicinteract__Conversation__c |
This field stores ID of a related Conversation record. |
Converse App |
smagicinteract__Converse_App__c |
This field stores ID of a related Converse App record. |
Converse App Action |
smagicinteract__Converse_App_Action__c |
This field stores ID of a related Converse App Action record. |
Converse App Task |
smagicinteract__Converse_App_Task__c |
This field stores ID of a related Converse App Task record. |
external field |
smagicinteract__external_field__c |
This field should be unique across records since this acts as an identifier for external systems. |
Favourite |
smagicinteract__Favourite__c |
This field identifies if incoming record is favorite or not. |
Inbound Number |
smagicinteract__Inbound_Number__c |
This field stores the number to which the customer has responded with a message. |
Lead |
smagicinteract__Lead__c |
This field stores ID of a related lead record. |
Message Type |
smagicinteract__MMS_Type__c |
This field tells if the incoming is of type SMS or MMS. |
MMS Url |
smagicinteract__MMS_Url__c |
This field is deprecated and is not being used. |
Mobile Number |
smagicinteract__Mobile_Number__c |
This field stores the mobile number of the customer who has sent incoming. |
Mobile Number without ISD Code |
smagicinteract__Mobile_Number_without_ISD_Code__c |
This field stores mobile number without ISD code. |
New |
smagicinteract__New__c |
This boolean field states if the incoming has been read or not. |
Outgoing SMS |
smagicinteract__outgoing_sms__c |
This field stores ID of the last outgoing SMS record. |
Quick Reply URL |
smagicinteract__Quick_Reply_URL__c |
This field is deprecated and is not being used. |
Sent By |
smagicinteract__Sent_By__c |
This field stores ID of a related user record. |
SMS Text |
smagicinteract__SMS_Text__c |
This field stores the incoming text sent by the customer. |
TaskID |
smagicinteract__taskId__c |
This field stores ID of a related task record. |
User |
smagicinteract__User__c |
This field stores ID of a related user record. |
If you want to receive MMS replies from your contacts, a record of this object is created. This object has a master-detail relationship with Incoming SMS. For each MMS response, a single record of Incoming MMS Detail gets created. Though it will still be available, this object will remain as-is and no future enhancements will be made to it.
Label |
API Name |
Purpose |
Incoming SMS |
smagicinteract__Incoming_SMS__c |
This field stores ID of a related incoming SMS record. |
MMS Type |
smagicinteract__MMS_Type__c |
This field stores the MMS URL type. |
MMS URL |
smagicinteract__MMS_URL__c |
This stores the MMS URL. |
This object will store the user templates for sending SMS.
Label |
API Name |
Purpose |
Description |
smagicinteract__Description__c |
This field stores the description about the template. |
Name |
smagicinteract__Name__c |
This field stores the name of the template. |
ObjectName |
smagicinteract__ObjectName__c |
This stores the primary object of the template. |
Text |
smagicinteract__Text__c |
This stores the template text. |
This object stores the Sender ID used by your organization.
Label |
API Name |
Purpose |
Description |
smagicinteract__Description__c |
This field stores the description about the Sender ID. |
Label |
smagicinteract__Label__c |
This field stores the label/short name of the Sender ID. |
SenderID |
smagicinteract__senderId__c |
This stores the Sender ID. |
Used For |
smagicinteract__Used_For__c |
This field specifies the use for Sender ID in incoming, outgoing or both. |
This object stores the default Sender ID for a given user and profile. A Sender ID can be set default to a profile or a user.
Label |
API Name |
Purpose |
Default SenderId |
smagicinteract__Default_SenderId__c |
This formula field stores the Sender ID. |
Profile |
smagicinteract__Profile__c |
This field stores the profile name for which Sender ID is default. This field is deprecated. |
Profile Id |
smagicinteract__Profile_Id__c |
This field stores the profile ID for which Sender ID is default. |
Sender Id (Deprecated) |
smagicinteract__Sender_Id__c |
This field is deprecated. |
SenderId Lookup |
smagicinteract__SenderId_Lookup__c |
This field stores the ID of the Sender ID object for which the default profile and user is set. |
User |
smagicinteract__User__c |
This field stores the user id for which Sender ID is default. |