Our documentation is changing, please click here to enjoy it!
This API route allows you to send a new message to targets. This new message won't be visible on the Accengage interface but will be linked to an existing one (the "parent" message).
Operations
|
|
| Parameter | Model |
body | 1) Sending on only one application (one partner) Data (send on 1 application) 2) Sending on multi applications (several partners) Data (send on multi applications) Messages
Message
Popup
Target
Criterion
Content
Aps
(1) Only available for Android push messages (2) Only available for iOS push messages (3) The name of the image must be provided by the uploadImage API (4) Only available when targeting one application (not for multi-applications) (5) Refer to the Apple documentation : https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html |
| Response | |
|---|---|
body | |
| Return code | |
returnCode | Description |
| Instant Message has been sent |
1 | A database error occured |
2 | No sendInstantMessage |
3 | No or bad user |
4 | No or bad partner |
5 | No or bad message |
6 | Bad custom params |
9 | Bad targets |
10 | No parent message ID |
11 | Message limit exceeded |
13 | Field unknown |
14 | Target max number exceeded |
15 | Template cannot be replaced |
16 | No or bad appId |
17 | The selected language does not exist |
22 | Invalid certificate |
If the message has been sent (returnCode: 0) in the case of multiple partners, you will only get the
messageId of the last message that you have provided in the Messages array.
The targets array contains all target definition for the message(s). This array can contain up to 100 entries.
One target object can contain multiple criteria, so a device will be targeted if all the criteria match the device properties. In the example below, a device will only be targeted if its language property is set to "en" AND the user opened the application more than once.
The message text can contain template macros. These templates will be replaced with, in order:
- values set in API target
dataobject - values set in API message
dataobject - values set in the devices database
If no value is found, an error is triggered.
Examples
| Request | Body | Description |
|---|---|---|
| Exemple with one application Exemple with multi applications | Sends an instant message |