SMSWhatsAppVoiceVideoAPIIntegrationRelease NotesFAQs
Contact UsKaleyra.io Sign InSupport

Received SMS Custom Data Object on Eloqua

The Received SMS Custom Data Object (CDO) captures the log of the user numbers that have opted out of the campaign triggered via Campaign Canvas and Program Canvas.

Suggest Edits

About Received SMS CDO

The Received SMS CDO enables you to access a log of user numbers that have opted out of the campaign. When a particular contact Opts-out of an SMS subscription, that contact will no longer receive SMS from the last sender ID used to send messages. However, Kaleyra.io will not completely block the contact, the contact can still receive SMS from other Sender IDs.

📘

Note

For the opt-out feature to be working the user needs to purchase the short/long code. Contact the Kaleyra team for more details.

You can export the log from the Received SMS CDO and either save the data or use it for further analysis.

📘

Note

The contact mapping works only when the message originated number is found in past campaigns of the “kaleyra send SMS“ app otherwise the contact linking will not be done.

Prerequisites for the Received SMS CDO

To view the details in the Eloqua Received SMS CDO the following need to be set up:

  • An SMS campaign is set up in Eloqua.
  • The Opt-Out feature is set up in Kaleyra.io. For information regarding the opt-out setting in Kaleyra.io refer to the Opt-Out Settings section.
  • A Callback Profile is set up in Kaleyra.io.

Create a callback profile

  1. Click the Profile down arrow and click Settings. The Settings > Notifications page is displayed.
  2. Click Callback Profiles. The Settings > Callback Profiles page is displayed.

  1. Click Create New.
  2. Enter a title for the call back profile.
  3. From the HTTP Method list, select Post.
  4. In the Endpoint field, enter the following:
https://eloqua-api.kaleyra.io/common/webhook/message-originated
  1. From the Body Type list, select JSON.
  2. In the Request Body field, enter the following:
{ 
 "message_id" : "<message_id>", 
 "sender" : "<identifier>", 
 "number" : "<sender>", 
 "body" : "<message>", 
 "company_name":"<status>", 
 "identifier": "<identifier>" 
}
  1. Click Save.
  2. Share the Callback Profile ID with the Kaleyra team so that the backend configuration can be complete.

Access the Received SMS CDO

You can access the log of all the user numbers that have opted out of the campaign using the Received SMS CDO.

To access the Received SMS CDO:

  1. Log in to Oracle Eloqua.
  2. From the ORACLE Eloqua menu bar, click Audience > Custom Objects. The Custom Objects page appears.
  3. From the All Custom Objects list, click the drop-down arrow corresponding to Kaleyra.io Received SMS and then click Custom Object Records Data. This displays the details of the SMS received such as internal ID, campaign name, phone number, the status of the SMS and, so on.

Values available in Received SMS CDO

Each Received SMS CDO contains the following values:

ValueDescription
InternalIdRequest ID of incoming webhook call with epoch timestamp.
ContactIdIdentifier of the Eloqua contact, as assigned by the Eloqua platform.

This ID is used to map each Received SMS to its contact. These are the contact links if available in recent campaigns.
PhoneNumberThe phone number of the Eloqua contact, in international format.
SenderThe Sender ID used by the campaign. An identifier of the sender of the message.
SMSTextThe text message as displayed in the SMS.
CampaignThe name of the campaign.

The campaign name is retrieved from the campaign canvas itself, as specified in the Save As operation during the campaign configuration phase.

Updated 4 months ago