Retrive a list of push
GET
/mobile_push/list
Retrieves a list of push. A maximum of 100 extensions could be returned per request.
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.sort_by
enum
required
Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.
Sample Request
https://example.com/api/mobile_push/list?access_token=196ACE20C6F34027895F7F95402BB164&sort_by=DEFAULT
Response
Placeholders
sort_by
enum
required
Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.page_count
integer
required
The total count of pages.count
integer
required
Current pagesize.push
array
required
Show child attributesCollection of push objects returned.
Sample Response
{
"sort_by": "DEFAULT",
"page_count": 100,
"count": 100,
"push": [
{
"app_id": "app_id 1",
"enabled": true
}
]
}
Create a new push
POST
/mobile_push/create
Create a new push.
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.app_id
string
optional
app_id.enabled
boolean
optional
enabled.mode
string
required
Push mode: PRODUCTION or DEVELOPMENT.android_server_key
string
optional
android_server_key.android_sender_id
string
optional
android_sender_id.ios_crt_filename
string
optional
ios_crt_filename.ios_crt_data
string
optional
ios_crt_data.ios_private_key_filename
string
optional
ios_private_key_filename.ios_private_key_data
string
optional
ios_private_key_data.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"app_id": "app_id 1",
"enabled": true,
"android_server_key": "Sample server key",
"android_sendid": "android_sendid 1",
"android_sender_id": "Sample sender ID",
"ios_crt_filename": "Sample crt filename",
"ios_crt_data": "Sample crt file data",
"ios_private_key_filename": "Sample key filename",
"ios_private_key_data": "Sample key data"
}
Response
Placeholders
Sample Response
Retrive push content
GET
/mobile_push/show
Retrieves push content.
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.app_id
string
required
The app id of push.
Sample Request
https://example.com/api/mobile_push/show?access_token=196ACE20C6F34027895F7F95402BB164&app_id=Sample+app+id
Response
Placeholders
app_id
string
optional
app_id.enabled
boolean
optional
enabled.mode
string
required
Push mode: PRODUCTION or DEVELOPMENT.android_server_key
string
optional
android_server_key.android_sender_id
string
optional
android_sender_id.ios_crt_filename
string
optional
ios_crt_filename.ios_crt_data
string
optional
ios_crt_data.ios_private_key_filename
string
optional
ios_private_key_filename.ios_private_key_data
string
optional
ios_private_key_data.
Sample Response
{
"app_id": "app_id 1",
"enabled": true,
"android_server_key": "Sample server key",
"android_sendid": "android_sendid 1",
"android_sender_id": "Sample sender ID",
"ios_crt_filename": "Sample crt filename",
"ios_crt_data": "Sample crt file data",
"ios_private_key_filename": "Sample key filename",
"ios_private_key_data": "Sample key data"
}
Update an push
POST
/mobile_push/update
Modify the push.
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.app_id
string
optional
app_id.enabled
boolean
optional
enabled.mode
string
required
Push mode: PRODUCTION or DEVELOPMENT.android_server_key
string
optional
android_server_key.android_sender_id
string
optional
android_sender_id.ios_crt_filename
string
optional
ios_crt_filename.ios_crt_data
string
optional
ios_crt_data.ios_private_key_filename
string
optional
ios_private_key_filename.ios_private_key_data
string
optional
ios_private_key_data.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"app_id": "app_id 1",
"enabled": true,
"android_server_key": "Sample server key",
"android_sendid": "android_sendid 1",
"android_sender_id": "Sample sender ID",
"ios_crt_filename": "Sample crt filename",
"ios_crt_data": "Sample crt file data",
"ios_private_key_filename": "Sample key filename",
"ios_private_key_data": "Sample key data"
}
Response
Placeholders
Sample Response
Remove a push
POST
/mobile_push/destroy
Deletes a certain push.
Request
Placeholders
access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.app_id
string
required
app_id of push.
Sample Request
{
"access_token": "196ACE20C6F34027895F7F95402BB164",
"app_id": "Sample app id"
}
Response
Placeholders