Create and scheduled push message
Available from |
|---|
v14+ |
Query Parameters
| Name | Type | Description |
|---|---|---|
| pushMessage | PushMessage | An object that contains a definition of the push message to be created. |
Result
| Type | Description |
|---|---|
| PushMessageResponse | An object that contains the response data. |
Exceptions
| Type | Description |
|---|---|
| InvalidParameterException | One of the parameters is invalid. |
| NoSuchObjectException | The message ID or user ID cannot be found. |
| UnexpectedErrorException | An unexpected backend error occurred. |
createAndSchedulePushMessage(PushMessage pushMessage) : PushMessageResponse
This endpoint creates a new push message and schedules the message.
| Source | mobilePush | |
|---|---|---|
| Method | POST | |
| Endpoint | [REST URL]/mobilePush/createAndSchedulePushMessage | |
| Input | name, appId, selectionPlanId, content, messageTitle, notificationSound, pushActionType, pushActionParams, buttonCategory, buttonActionType buttonActioParams, mediaType, mediaUrl | |
| Output | Json Object | |
| Request example |
| |
| Response code | ||
| Response example |
|
Request field description:
field | description | allowed values | required |
|---|---|---|---|
| name | message name | true | |
| appId | mobile application id (created on UI) | true | |
| selectionPlanId | selection plan id (created on UI) if empty, message will be sent to all optIn users | false | |
| content | text message content | true | |
| messageTitle | title of message | true | |
| description | description | false | |
| notificationSound | optional field, if added, sound must be defined in application | false | |
| pushActionType | action type | LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE | false |
| pushActionParams | url params related with action type, required if action type is not equal to LAUNCH_APP | false | |
| buttonCategory | buttons category | apx_yes_no_open, apx_acc_dec_open, apx_buy_open, apx_read_open | false |
| buttonActionType | primary button action | LAUNCH_APP, OPEN_LANDING_PAGE, OPEN_DEEP_LINK, OPEN_STORE | false |
| buttonActionParams | url params related with button action type, required if type is not equal to LAUNCH_APP | false | |
| mediaType | media type | IMAGE, VIDEO | false |
| mediaUrl | url address of media file from mapp content store | false | |
| scheduledTime | scheduled Time | false | |
| timeZone | timeZone | false |