Contents x
    /mobilePush/getPushMessage
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /mobilePush/getPushMessage

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /mobilePush/getPushMessage

    Get push message.

    Query parameters
    messageId
    integer (int64) Required

    The message ID.

    Responses
    200

    Example response:
    {
    "messageId" : 1,
    "status" : "COMPLETED"
    "owner" : {
    "firstName" : "Radmila",
    "lastName" : "Petrovic",
    "email" : "radmila.petrovic@mapp.com"
    },
    "lastModified" : "2020-07-31T12:44:46.966Z",
    "name" : "test name",
    "appId" : "1585031493269",
    "selectionPlanId" : "768E488C-45C2-4A6F-800B-C569586F1DC5",
    "content" : "This is iOS test push ",
    "messageTitle" : "Hello",
    "description" : "description",
    "notificationSound" : "sound1.mp3",
    "pushActionType" : "LAUNCH_APP",
    "pushActionParams" : "www.test.com",
    "buttonCategory" : "apx_read_open",
    "buttonActionType" : "OPEN_LANDING_PAGE",
    "buttonActionParams" : "https://www.google.com/",
    "mediaType" : "IMAGE", - optional
    "mediaUrl" : "https://staging11.shortest-route.com/qatest/imgproxy/img/110/5ac68ca5498a5.png",
    "scheduledTime" : "2020-07-31T12:44:46.966Z",
    "timeZone" : "Europe/Budapest"
    }

    Expand All
    object
    messageId
    integer (int64)
    status
    string
    lastModified
    string
    owner
    object (Owner)
    firstName
    string
    lastName
    string
    email
    string
    name
    string
    description
    string
    appId
    string
    selectionPlanId
    string
    content
    string
    messageTitle
    string
    notificationSound
    string
    pushActionType
    string
    Valid values[ "DISMISS", "LAUNCH_APP", "OPEN_DEEP_LINK", "OPEN_LANDING_PAGE", "OPEN_STORE" ]
    pushActionParams
    string
    buttonCategory
    string
    Valid values[ "apx_acc_dec_open", "apx_buy_open", "apx_read_open", "apx_yes_no_open" ]
    buttonActionType
    string
    Valid values[ "DISMISS", "LAUNCH_APP", "OPEN_DEEP_LINK", "OPEN_LANDING_PAGE", "OPEN_STORE" ]
    buttonActionParams
    string
    buttonLanguageCode
    string
    mediaType
    string
    Valid values[ "GIF", "IMAGE", "MUSIC", "VIDEO" ]
    mediaUrl
    string
    scheduledTime
    string
    timeZone
    string
    contentAvailable
    boolean
    Default"False"
    silentType
    string
    silentData
    string
    customFields
    Array of object (CustomField)
    object
    key
    string
    value
    string
    400

    One of the parameters is invalid / The message ID or user ID cannot be found. / An unexpected backend error occurred.

    404

    Error response: {
    "errorActor": "CLIENT",
    "errorCode": "INVALID_REQUEST",
    "message": "Not Found"
    }

    Was this article helpful?
    What's Next