JPush Subscription

The JPush Subscription API subscribes applications to send push notifications in China where Google is disabled.

URL

The HTTP URL for the JPush Subscription API is:

<host>:<port>/api/v1/subscribers

The JPush Subscription API applies the Gateway Filter for Authentication to authenticate a user’s credentials and allow access to the service.

Method

POST

Header

The payload’s request header includes Content-Type as application/json;charset=UTF-8.

Input Parameters

The following fields are input parameters:

Header

Based on the content format, the payload’s request header includes Content-Type for:

• XML as text/xml;charset=UTF-8
• JSON as application/json;charset=UTF-8

Sample Request

XML

<?xml version='1.0' encoding='UTF-8'?>
<subscriptionService>
<subscribe>
<appId>20096-6548262167</appId>
<deviceId>92345600XY</deviceId>
<ufid>aron.hale@voltmx.com</ufid>
<sid>923456XQYN</sid>
<osType>android</osType>
<isJpush>true</isJpush>
</subscribe>
</subscriptionService>

JSON

{
"subscriptionService": {
"subscribe": {
"sid": "0a043dda850",
"appId": "20096-6548262167",
"ufid": "aron.hale@voltmx.com",
"osType": "androidjpush",
"deviceId": "09XCUYT909",
"isJpush": true
}
}
}

Sample Response

XML

<subscriptionResponse>
<statusCode>200</statusCode>
<ksid>xxxx</ksid>
<message>Subscription successful. </message>
</subscriptionResponse>

JSON

{
"id" : "4927821427136428978",
"message" : "Subscription successful. "
}

Response Status