What's new to the Advanced API
This section describes changes and enhancements to the Oracle Responsys Advanced APIs in product updates during the past year.
Update 22B
-
You can use the following new and updated endpoints.
- SMS Campaigns: You can now update and delete SMS invalid keyword response messages for codes present in the account.
- Message Center: This new set of endpoints enable you to create, retrieve, update and delete Message Center Direct Campaigns. See Message Center for details.
-
The Create Push Campaign endpoint now supports two new parameters to determine how push notifications are sent to iOS 15 and above devices: interruptionLevel and relevanceScore. See Push Campaigns Object Properties Reference to learn more about these parameters.
See an example
Create a push campaign for iOS 15 and above devices, using the
interruptionLevelandrelevanceScoreparameters to determine notification importance.{ "campaignMetadata": { "folderName": "<folderName>", "description": "<description>", "marketingStrategy": null, "marketingProgram": null, "appName": "<appName>" }, "dataSource": { "dataSourceTables": [ { "folder": "<dataSourceFolderName>", "type": "CHANNEL_LIST", "alias": "<dataSourceAlias>", "name": "<dataSourceName>", "columns": [ { "alias": "<columnAlias>", "defaultValue": <defaultValue>, "name": "<columnName>", "lookupKey": false }, { "alias": "<columnAlias>", "defaultValue": "<defaultValue>", "name": "<columnName>", "lookupKey": false } ] }, { "folder": "~System", "type": "PROFILE_LIST", "alias": "<folderAlias>", "name": "Push_App_List", "columns": [ { "alias": "MOBILE_NUMBER_", "defaultValue": null, "name": "MOBILE_NUMBER_", "lookupKey": false } ] }, { "folder": "Push", "type": "PROFILE_EXTENSION", "alias": "Profile_Pet", "name": "Profile_Pet", "columns": [ { "alias": "<listAlias>", "defaultValue": null, "name": "<RIID_IO>", "lookupKey": false } ] }, { "folder": "Push", "type": "CHANNEL_EXTENSION", "alias": "APP_CHANNEL_PET", "name": "APP_CHANNEL_PET", "columns": [ { "alias": "<listAlias>", "defaultValue": null, "name": "DGF_APP_PET", "lookupKey": false } ] }, { "folder": "Push", "type": "SUPPLEMENTAL_TABLE", "alias": "Valid_Supp", "name": "Valid_Supp", "columns": [ { "alias": "BROWSER_", "defaultValue": null, "name": "BROWSER_", "lookupKey": false } ] } ], "dynamicVariables": { "columns": [ { "alias": "<dynamicVariable>", "defaultValue": null }, { "alias": "<dynamicVariable>", "defaultValue": null } ] } }, "message": { "title": "<title>", "textMessage": "<textMessage>", "iosMedialUrl": "<iosMediaUrl>", "androidImageUrl": "<androidImageUrl>", "deepLinkUrl": "<deepLinkUrl>", "interruptionLevel": "active", "relevanceScore": 0.5 }, "launchSettings": { "progressEmailAddresses": [ "<progressEmailAddress>", "<progressEmailAddress>" ], "skipAlertEnabled": true, "skipAlertPercent": 10, "sentAlertEnabled": false, "sentAlertPercent": null, "startAlertEnabled": false, "emptyAlertEnabled": false, "failureEmailAddresses": [ "<failureEmailAddress>", "<failureEmailAddress>" ], "skippedLaunchEmailAddresses": [ "<skippedLaunchEmailAddress>" ], "launchThrottleRate": <launchThrottleRate> }, "targeting": { "filterNames": [ ], "audienceName": null, "allRecipients": true } }
Update 22A
-
The Responsys Advanced API is now Generally Available to all customers. This includes access to all 34 API endpoints across 12 API Categories.
Update 21D
There are no significant updates to the Advanced REST API.
Update 21B
You can use the following new and updated endpoints.
-
SMS Campaigns: The create, retrieve, and update SMS Campaign API endpoints will now return a Campaign
idproperty. Theididentifies the SMS campaign's unique identifier.See an example
Retrieve an SMS Campaign with the ID "Summer_Campaign"
GET /rest/sms/api/v1.3/campaigns/Summer_Campaign
Response:
{ "generalInfo": { "id": 100, "folderName": "folderName", "purpose": "Promotional", "description": "This is a campaign", "marketingStrategy": null, "marketingProgram": null, "template": "Custom", "assignedOrganizations": null }, "dataSources": [ { "id": 15649786, "folder": "sampleFolder", "type": "PROFILE_LIST", "alias": "profileList", "name": "profileList", "columns": [ ], "lookupTable": false } ], "messageInfo": { "codeCountries": [ { "code": "28179", "country": "US" } ], "outboundMessage": "Hello!", "responseMessages": [ ], "enableLinkTracking": false, "linkTablePath": "" }, "additionalInfo": { "externalTrackingParams": null, "campaignVariables": null, "initiationType": "Y", "externalTracking": null, "externalTrackingEnabled": false, "honorPermission": false, "emailOptIn": false, "smsOptIn": false, "smsOptOutFromAllLists": false, "active": false }, "launchOptions": { "progressAddress": "api.user@oracle.com", "skipAlertEnabled": false, "skipAlertPercent": 50, "sentAlertEnabled": false, "sentAlertPercent": 20, "startAlertEnabled": false, "emptyAlertEnabled": true, "failureAddress": "api.user@oracle.com", "withdrawnAddress": "api.user@oracle.com", "launchRate": null }, "targeting": null, "links": [ { "rel": "self", "href": "/rest/api/sms/v1.3/campaigns/Summer_Campaign", "method": "POST" }, { "rel": "getSMSCampaign", "href": "/rest/api/sms/v1.3/campaigns/Summer_Campaign", "method": "GET" }, { "rel": "deleteSMSCampaign", "href": "/rest/api/sms/v1.3/campaigns/Summer_Campaign", "method": "DELETE" }, { "rel": "updateSMSCampaign", "href": "/rest/api/sms/v1.3/campaigns/Summer_Campaign", "method": "PUT" } ] } - SMS Campaigns: You can now send SMS campaign messages under Distributed Ledger Technology (DLT) regulations by specifying the
smsDltInfoparameter. Refer to SMS Campaigns Object Properties Reference to learn more.
Update 21A
You can use the following new and updated endpoints.
- SMS Message Preview: This new endpoint enables you to return the personalized SMS message for the specified recipient. See Preview SMS Campaign Message for details.
- Update Email Campaign Properties: This endpoint has been updated to enable you to update or delete an email campaign's Data Sources. Include Data Sources in the request body to update, and leave the request body empty to delete. See Update Email Campaign Properties for details.