Push plugin required
This collection might not appear if you don't have push plugin enabled
Collection messages contains data about created push messages Here is the list of fields available:
| Field | Description | Example |
|---|---|---|
| _id | ID of the message | 574d6cfda7cbc34d4fae097f |
| type | Type of the message: message, link, category, update review, data | message |
| apps | Array of app IDs to which users' to send message | [ "56e53239a941253d470d7c52" ] |
| appNames | Array of app names to which users' to send message | [ "Test" ] |
| status | Status of the message: 0 - scheduled 1 - processing 2 - sent 3 - failed | 0 |
| platforms | Array of platforms to send message to: a - android i - ios | [ "a" ] |
| userConditions | Query for users collection | {"av":{"$in":["1:2"]}} |
| drillConditions | Query for drill collection |
{ |
| geo | Id of Geolocation to send message to | 574d71c8a7cbc34d4fae09dc |
| messagePerLocale | Message text for each provided locale | { "default": "Test", "en": "Test", "fr": "Le Test", "de": "Das Test" } |
| sound | Sound to play on message received | default |
| badge | Number to show by the badge | 1 |
| data | JSON data to send with message | {"test":"key"} |
| result | Result of processing the message | { "status": 0, "total": 0, "processed": 0, "sent": 0 } |
| expiryDate | If not delivered by this date, do not send anymore | 2016-06-07T12:00:00.000Z |
| created | Date when message was created | 2016-05-31T10:52:45.915Z |
| locales | List of available locales and ratio for the users of this message | { "it": "0.14", "ja": "0.12", "en": "0.27", "fr": "0.15", "ko": "0.15", "de": "0.15", "default": "0.57" } |
| test | Should this message be sent only to test devices | false |
| date | Scheduled date | 2016-05-31T12:00:00.000Z |
Here is how an example document could look like
{
"_id": "574d6cfda7cbc34d4fae097f",
"type": "message",
"apps": [
"56e53239a941253d470d7c52"
],
"appNames": [
"Test"
],
"status": 0,
"platforms": [
"a"
],
"userConditions": "{}",
"drillConditions": "{}",
"geo": "",
"messagePerLocale": {
"default": "Test",
"en": "Test",
"fr": "Test"
},
"sound": "default",
"badge": 1,
"result": {
"status": 0,
"total": 0,
"processed": 0,
"sent": 0
},
"expiryDate": "2016-06-07T12:00:00.000Z",
"created": "2016-05-31T10:52:45.915Z",
"locales": {
"it": "0.14",
"ja": "0.12",
"en": "0.27",
"fr": "0.15",
"ko": "0.15",
"de": "0.15",
"default": "0.57"
},
"test": false,
"date": "2016-05-31T12:00:00.000Z"
}