Провайдеры: структура push сообщения

Altcraft Platform поддерживает следующие сервисы для отправки мобильных push сообщений:

• Google Firebase Cloud Messaging — для Android и iOS приложений
• Apple Push Notification Service — только для iOS приложений
• Yandex.AppMetrica — для Android и iOS приложений
• Huawei Mobile Services — для Android и iOS приложений
• RuStore — для Android приложений

примечание

Требуется подключение соответствующих SDK в приложении.

подсказка

Yandex.AppMetrica использует для отправки SDK Google Firebase. Для отправки уведомлений вам нужно будет установить его в приложение.

В Altcraft Platform доступна интеграция с Yandex.AppMetrica для импорта профилей пользователей, регистрации их действий и связанной с ними ценности (стоимости).

Необходимо проверить, что приложение поддерживает структуру push-уведомлений Altcraft Platform. Если формат не поддерживается, Altcraft может скорректировать структуру сообщения со своей стороны.

Формат отправки push сообщения

Android Firebase (legacy)

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"to": "SubscriptionID",
	"priority": "Priority",
	"time_to_live": 0-86400,
	"content_available": true,
	"mutable_content": true,
	"data": {
		"uid": "UID",
		"message": "Body",
		"mediaUrl": "Icon",
        "image": "Image",
		"launch_id": "LaunchID",
		"hub_link": {
			"open": "URLOpenEvent",
			"ack": "URLDelivEvent"
		}
	},
	"notification": {
		"title": "Title",
		"body": "Body",
		"icon": "Icon",
		"color": "ImageBackgroundColor",
		"click_action": "ClickURL",
		"sound": "Sound"
	}
}

подсказка

uid — внутренний идентификатор отправки, уникальный для каждого сообщения. launch_id — внутренний идентификатор отправки, уникальный в рамках рассылки.

Android Firebase (api v1)

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"message": {
		"token": "SubscriptionID",
		"android": {
			"priority": "Priority",
			"ttl": TTL,
			"data": {
				"uid": "UID",
				"launch_id": "LaunchID",
				"hub_link": "{\"open\": \"URLOpenEvent\", \"ack\": \"URLDelivEvent\"}"
			},
			"notification": {
				"title": "Title",
				"body": "Body",
				"icon": "Icon",
				"click_action": "ClickURL",
				"sound": "Sound",
				"color": "ImageBackgroundColor",
				"light_settings": {
					"color": {
						"red": 0-1,
						"green": 0-1,
						"blue": 0-1,
						"alpha": 0/1
					},
					"light_on_duration": "LEDOnDuration",
					"light_off_duration": "LEDOffDuration"
				},
				"image": "Image",
				"default_vibrate_timings": true/false,
				"notification_count": 0-999
			}
		}
	}
}

подсказка

uid — внутренний идентификатор отправки, уникальный для каждого сообщения. launch_id — внутренний идентификатор отправки, уникальный в рамках рассылки.

iOS Firebase (legacy)

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"to": "SubscriptionID",
	"priority": "Priority",
	"time_to_live": 0-86400,
	"content_available": true,
	"mutable_content": true,
	"data": {
		"uid": "UID",
		"message": "Body",
		"mediaUrl": "Icon",
        "media": "Media",
		"launch_id": "LaunchID",
		"hub_link": {
			"open": "URLOpenEvent",
			"ack": "URLDelivEvent"
		}
	},
	"notification": {
		"title": "Title",
		"body": "Body",
		"icon": "Icon",
		"color": "ImageBackgroundColor",
		"click_action": "ClickURL",
		"sound": "Sound"
	}
}

подсказка

uid — внутренний идентификатор отправки, уникальный для каждого сообщения. launch_id — внутренний идентификатор отправки, уникальный в рамках рассылки.

iOS Firebase (api v1)

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"message": {
		"token": "SubscriptionID",
		"apns": {
			"headers": {
				"apns-expiration": "TTL"
			},
			"payload": {
				"aps": {
					"badge": 0-999,
					"sound": "Sound",
					"mutable-content": 1,
					"alert": {
						"title": "Title",
						"subtitle": "SubTitle",
						"body": "Body"
					}
				},
				"click-url": "ClickURL",
				"uid": "UID",
				"launch_id": "LaunchID",
				"hub_link": "{\"open\": \"URLOpenEvent\", \"ack\": \"URLDelivEvent\"}",
				"media": "Media",
                "mediaUrl": "Icon" 
			},
			"fcm_options": {
				"image": "Media"
			}
		}
	}
}

подсказка

uid — внутренний идентификатор отправки, уникальный для каждого сообщения. launch_id — внутренний идентификатор отправки, уникальный в рамках рассылки.

iOS APNS

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"aps": {
		"badge": 0-999,
		"sound": "Sound",
		"mutable-content": 1,
		"alert": {
			"title": "Title",
            "subtitle": "SubTitle", 
			"body": "Body"
		}
	},
	"click-url": "ClickURL",
	"icon": "Icon",
    "media": "Media",
	"hub_link": {
		"open": "URLOpenEvent",
		"ack": "URLDelivEvent"
	}
}

AppMetrica iOS

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"push_batch_request": {
		"group_id": 97737,
		"tag": "tag",
		"batch": [
			{
				"messages": {
					"iOS": {
						"silent": true/false,
						"content": {
							"title": "Title",
							"text": "Body",
							"badge": 0-999,
							"expiration": 0,
							"data": "{\"hub_link\":{\"ack\":\"URLDelivEvent\",\"open\":\"URLOpenEvent\"},\"icon\":\"Icon\",\"media\":\"Media\"}"
						},
						"open_action": {
 							"url": "URL",
							"deeplink": "Deeplink"
						}
					}
				},
				"devices": [
					{
						"id_values": ["SubscriptionID"],
						"id_type": "ios_push_token"
					}
				]
			}
		]
	}
}

AppMetrica Android

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"push_batch_request": {
		"group_id": 97737,
		"tag": "tag",
		"batch": [
			{
				"messages": {
					"android": {
						"silent": true/false,
						"content": {
							"title": "Title",
							"text": "Body",
							"time_to_live": 0,
							"image": "Icon",
							"icon_background": "IconBackground",
							"banner": "Banner",
							"led_color": "LEDColor",
							"data": "{\"hub_link\":{\"ack\":\"URLDelivEvent\",\"open\":\"URLOpenEvent\"}}"
						},
						"open_action": {
 							"url": "URL",
							"deeplink": "Deeplink"
						}
					}
				},
				"devices": [
					{
						"id_values": ["SubscriptionID"],
						"id_type": "google_aid"
					}
				]
			}
		]
	}
}

HMS Android

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"message":{
		"android":{
			"notification":{
				"badges":{
					"set_num":2
				},
				"body":"Уважаемый пользователь, предлагаем Вам наш новый продукт, productName!",
				"click_action":{
					"intent":"#Intent;compo=com.example/app2;S.W=U;end",
					"type":1
				},
				"color":"#cdc167",
				"icon":"https://i.postimg.cc/2yVZyQMn/demo-Push-Icon.jpg",
				"importance":"NORMAL",
				"light_settings":{
					"color":{
						"alpha":1,
						"blue":0.70980394,
						"green":0.78039217,
						"red":0.5686275
					},
				"light_off_duration":"1.5s",
				"light_on_duration":"1.5s"
				},
				"sound":"tadaam.ogg",
				"title":"Title of push message"
			},
			"params":{
				"hub_link": "{\"open\": \"URLOpenEvent\", \"ack\": \"URLDelivEvent\"}",
				"launch_id":"2_6j_4LxYQQ8VECT",
				"uid":"w4LxYQQsznE1_2_6j_i_o___4.2Pzr5NNonCwUWQwvJ_4u71jH"
			},
			"ttl":"604800s"
		},
		"token":[
			"AGIwonWCgyDXGEG-airg4cUbVxeq0RFDfTuDM2hPWRrxfMociyvLNmn-GWdd4I6ZDrXIee46IrWSjC-cPDauP3ciS74bVi8wJ7T3PwHhvEY38VdYSu5zeHRXQzBRDgTnxA"
		]
	}
}

HMS iOS

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
	"message":{
		"apns":{
			"headers":{
				"apns-expiration":"3600"
			},
			"hms_options":{
				"target_user_type":1
			},
			"payload":{
				"apple":"red",
				"aps":{
					"alert":{
						"body":"Уважаемый пользователь, предлагаем Вам наш новый продукт, productName!",
						"subtitle":"sub title",
						"title":"Title of push message"
					},
					"badge":0,
					"mutable_content":1,
					"sound":"default"
				},
				"click-url":"",
				"hub_link": "{\"open\": \"URLOpenEvent\", \"ack\": \"URLDelivEvent\"}",
				"launch_id":"2_6j_4LxYKovmDvu",
				"mediaUrl":"https://i.postimg.cc/2yVZyQMn/demo-Push-Icon.jpg",
				"uid":"w4LxYKq9nBMc_2_6j_i_o___4.2Pzr5NNonCwUWQwvJ_aDfVX"
			}
		},
		"token":[
			"IQAAAACy0huaAQwLF6BO92GYzCAnfqZgaxhD1f7wLWGmOxQ6bFKCQYQQYtTi2-1hXHlsXAnCzLQdX3m4RTCCEI-KYu-XcaBJYovDZANg2eRTvPv7qA"
		]
	}
}

RuStore Android

примечание

Возможно редактирование объекта JSON (по запросу).

Поддерживается добавление дополнительных данных в объект data. Это можно сделать для каждой отправки персонально в настройках сообщения Altcraft MP.

{
  "validate_only": false,
  "message": {
    "token":  "{{.SubscriptionID}}",
    "data": {
      "uid": "{{.UID}}",
      "message": "{{.Body}}",
      "mediaUrl": "{{.Icon}}",
      "image":   "{{.Image}}",
      "launch_id": "{{.LaunchID}}",
      "hub_link": "{\"open\": \"{{.URLOpenEvent}}\", \"ack\": \"{{.URLDelivEvent}}\"}"
    },
    "android": {
      "priority": "{{.Priority}}",
      "notification": {
        "title": "{{.Title}}",
        "body": "{{.Body}}",
        "icon": "{{.Icon}}",
        "color": "{{.ImageBackgroundColor}}",
        "image": "{{.Image}}",
        "click_action": "{{.ClickURL}}",
        "sound": "{{.Sound}}",
        "channel_id": "{{.ChannelID}}",
        {{if ne .LEDColorHex ""}}
        "light_settings": {
          "color": {
            "red": {{.LEDColorSRGBA.R}},
            "green": {{.LEDColorSRGBA.G}},
            "blue": {{.LEDColorSRGBA.B}},
            "alpha": {{.LEDColorSRGBA.A}}
          },
          "light_on_duration": "{{.LEDOnDuration}}",
          "light_off_duration": "{{.LEDOffDuration}}"
        },
        {{end}}
        "notification_count": {{.Badges}}
      },
      "ttl": {{.TTL}}
    }
  }
}

подсказка

uid — внутренний идентификатор отправки, уникальный для каждого сообщения. launch_id — внутренний идентификатор отправки, уникальный в рамках рассылки.