Overview | Service | Command |
Registering app/device to receive push notifications
Authorization token required | true |
Admin Authorization token required | false |
<RegisterMobileGatewayAppRequest> ## RegisterMobileGatewayAppRequest
<zmgDevice appId="{app-id}" registrationId="{registration-id}" pushProvider="{push-provider}"
[osName="{os-name}"] [osVersion="{os-version}"] [maxPayloadSize="{max-payload-size} (Integer)"] /> ## ZmgDeviceSpec
</RegisterMobileGatewayAppRequest>
The following table describes elements and attributes you can define within a
<RegisterMobileGatewayAppRequest>
element:
XPath | Required / Optional | Description |
/zmgDevice | Required (only 1) | Zmg Device specification |
/zmgDevice@appId | Required (only 1) | Type:String App ID. |
/zmgDevice@registrationId | Required (only 1) | Type:String The registration id of the device for push notifications. |
/zmgDevice@pushProvider | Required (only 1) | Type:String the provider for pushing notifications to the device |
/zmgDevice@osName | Optional (0 or 1) | Type:String osName is the name of the operating system installed on the device. Example - ios, android |
/zmgDevice@osVersion | Optional (0 or 1) | Type:String The osVersion should be specified in the following formats - a) majorVersion.minorVersion.microVersion b) majorVersion.minorVersion Example - iOS having versions like 7.0, 8.0.3, 8.1 etc. Android has OS version like 2.0, 3.1, 4.4, 5.0 etc |
/zmgDevice@maxPayloadSize | Optional (0 or 1) | Type:Integer maxPayloadSize is the maximum number of bytes allowed for the push notification payload Example - iOS 7.0 default maxPayloadSize is 256 bytes iOS 8.0 onwards default maxPayloadSize is 2048 bytes Android default maxPayloadSize is 4096 bytes In case, the maxPayloadSize is not specified the default payload size defined in the above examples will be used while sending push notifications |
<RegisterMobileGatewayAppResponse /> ## RegisterMobileGatewayAppResponse