Our documentation is changing, please click here to enjoy it!

Skip to end of metadata
Go to start of metadata

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

POST

/sendInstantMessage.php

ParameterModel
body
Data

 


 

Message

 


 

Popup

 


 

Target

 


 

Criterion

 


 

Content

 


 

InteractiveButtons

The value of the template can be found in the category on the interface or here for the Accengage's templates.


 

Buttons

 


 

CustomParam
Response
body
Return code
returnCodeDescription

0

Instant Message has been sent

1A database error occured
2No sendInstantMessage
3No or bad user
4No or bad partner
5No or bad message
6Bad custom params
9Bad targets
10No parent message ID
11Message limit exceeded
13Field unknown
14Target max number exceeded
15Template cannot be replaced
16No or bad appId
17

The selected language does not exist 

23

No or bad template for buttons

24

No or bad button id

25

Bad custom params for buttons

The targets array contains all target definition for the message. 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.

 

If the action is set in the buttons, its value must be in browser, email, phone, store, sms, webView, urlSheme, and close.

 

The message text can contain template macros. These templates will be replaced with, in order:

  • values set in API target data object
  • values set in API message data object
  • values set in the devices database

If no value is found, an error is triggered.

Examples

RequestBodyDescription

POST URL

 

With buttons :

Sends an instant message
  • No labels