Push to segment API with inline content

Push to Segment API (also known as the Push to Contact Source API) with inline content, can be used from an external system, but not from the Campaign Automation UI.

📘

Note:

If the user wants to send a rich notification using this API, the rich content has to be created first using the Create Rich Content (POST:/channels/push/richcontent) or a valid rich content ID should be used. If a user wants to send an in-app notification using this API, the inapp content has to be created first using the In-App Content API (POST:/channels/push/inappcontent) or a valid inapp content ID should be used.

Functionalities available

The Push to Segment API with inline content call has POST functionalities.
POST: This call sends a push notification.
POST /channels/push/sendjobs

Swagger URL

https://api-campaign-us-[your pod number].goacoustic.com/restdoc/#!/channels/sendpush_to_segment_inline_source_post

Scenarios that can be accomplished using this API

Send to a predefined contact source/segment (database, query or contact list created in WCA) using content defined in the API payload.

The following mobile app messages supported:

• Simple
• Simple + inbox (rich content has to be created prior to using this API and must have a valid richcontent ID, see the Create Rich Content)
• Simple + Extension
• Inbox only (rich content has to be created prior to using this API and must have a valid richcontent ID, Create Rich Content)
• In-App only
• Data only

Additional information about this API

• Regular personalization can only be used with information known to Acoustic Campaign.
• Relational table personalization is supported (with 18.1 release, no error validation available).
• This API does check mobile app frequency limits and honors them.
• Messages can be scheduled
• Pre-processing can be specified, see the preBlockingHours attribute.
• Can schedule based on recipient’s timezone, see useRecipientTimezone attribute.

Request body

SendJobWithInlineSpecification

InlinePushContent

InboxMessage

**publishedmessageID from Campaign Automation cannot be used here.

InAppMessage

In-App Content API

SimplePushContent

iOSPushPayload

APS

IosAlertNode

Action

AndroidPushPayload

AndroidAlertNode

Sample JSON request body

Simple message

{
  "appKeys": [
    "gcU6M2fD9P"
  ],
  "contactSourceId": "332229",
  "campaignName": "Black Friday 2017 Offer",
  "messageName": "Black Friday 2017 morning Promotion",
  "useRecipientTimeZone":"true",
  "scheduledDate":"2017-04-18T16:30:51.123+00:00",
  "content": {
    "simple": {
      "gcm": {
        "alert": {
         "subject": "Special Black Friday Sale!",
          "message": "Extra 20% off for purchases before midnight!",
          "notification-action": {
            "type": "url",
            "name": "URL",
            "value": "http://www.ibm.com"
          }
        }
      }
    }
  }
 }

Personalization example

Personalization fields (first_name, last_name) are contact attributes known/within to Campaign Automation.

"contactSourceId": "1234567",
  "campaignName": "Push to segment with inline",
  "messageName": "Demo message name",
  "appKeys": [
    "apIOSappkey",
    "gcAndroidAppkey"
  ],
  "content": {
    "simple": {
      "apns": {
        "aps": {
          "alert": "Simple personalization test for %%first_name%% %%last_name%%",
          "sound": "default"
        },
        "notification-action": {
          "type": "url",
          "value": "http://www.ibm.com"
        }
      },
      "gcm": {
        "alert": {
          "subject": "Simple personalization test for %%first_name%% %%last_name%%",
          "message": "Simple",
          "notification-action": {
            "type": "url",
            "value": "http://www.ibm.com"
          },
          "highPriority": false,
          "sensitive": false
        }
      }
    }
  }
 }