1. Home
  2. API Documentation
  3. Send a new message

Send a new message

Request Example https://pushenvoy.com/app/api/send_message/
Authentication Send the application access token in the HEADER or POST body for each API request with parameter name `Access_Token` to pass the authentication layer
Send Type Send parameters in POST
Parameters
platform
DescriptionSend to all devices by their platforms
TypeJSON String(ios,android,wp,wp10,bb,chrome,safari,firefox)
Example{“ios”,”android”,”safari”,”chrome”}
RequiredNo
device_token
DescriptionSend one device only by providing its device type and token
Typestring
RequiredNo
device_type
DescriptionSupport iOS, Android, Windows Phone 8, BlackBerry 10, Chrome, Safari and Firefox devices
TypeChoose(ios,android,wp,wp10,bb,chrome,safari,firefox)
RequiredNo
title
DescriptionPut a title for your message
TypeString
RequiredYes
message
DescriptionThe message body
TypeString
RequiredYes
send_type
DescriptionThe sending type of your message
TypeChoose(now,time,geofence,template)
RequiredYes
send_time
DescriptionSend the message in a determined time
TypeDateTime(yyyy-mm-dd h:i a)
Example2016-5-06 12:00 am
RequiredNo
send_repeatly
DescriptionEnable sending message in repeatly times
TypeSet the value = enabled to activate this feature or leave it empty to disable
RequiredNo
repeat_interval
DescriptionWhen enable sending repeatly times you should send the repeat interval
TypeChoose(minute,hour,day,month,year)
RequiredNo
repeat_age
DescriptionWhen enable sending repeatly times you should send the repeat age
TypeNumber
ExampleIf you set the value of repeat_interval = day and repeat_age = 3 so the message will send every 3 days
RequiredNo
status
DescriptionActivation status of message
Typeboolean(1,0) default is 1
RequiredNo
payload
DescriptionSend custom payload with your message
TypeJSON String
Example{“id”:”11″,”type”:”message”,”url”:”link”}
RequiredNo
desktop_title
DescriptionThe title of message if you will send the desktop platforms
TypeString
RequiredNo
desktop_link
DescriptionThe link of desktop notification message to open
TypeURL
RequiredNo
desktop_icon
DescriptionLink of an 150×150 image to appear in the desktop push message when delivered
TypeString
RequiredNo
latitude
DescriptionLatitude point for sending to all devices exist in the selected area
TypeNumber
RequiredNo
longitude
DescriptionLongitude point for sending to all devices exist in the selected area
TypeNumber
RequiredNo
radius
DescriptionRadius value in miles for sending to all devices exist in the selected area
TypeNumber
RequiredNo
inchannels_and
DescriptionFilter the devices by users subscribed in channels with AND relation
TypeJSON String(IDs of channels)
Example{“1″,”2″,”22″,”223”}
RequiredNo
inchannels_or
DescriptionFilter the devices by users subscribed in channels with OR relation
TypeJSON String(IDs of channels)
Example{“1″,”2″,”22″,”223”}
RequiredNo
notchannels_and
DescriptionFilter the devices by users not subscribed in channels with AND relation
TypeJSON String(IDs of channels)
Example{“1″,”2″,”22″,”223”}
RequiredNo
notchannels_or
DescriptionFilter the devices by users not subscribed in channels with OR relation
TypeJSON String(IDs of channels)
Example{“1″,”2″,”22″,”223”}
RequiredNo
ios_slide
DescriptionChange (view) sentence in (Slide to view)
TypeString
RequiredNo
ios_badge
DescriptionThe number to display as the badge of the application icon
TypeNumber
RequiredNo
ios_sound
DescriptionThe name of a sound file in the application bundle
TypeString
RequiredNo
ios_cavailable
DescriptionProvide this key with a value of 1 to indicate that new content is available
TypeString
RequiredNo
ios_launchimg
DescriptionThe filename of an image file in the application bundle
TypeString
RequiredNo
safari_slide
DescriptionChange the view button text when Safari desktop message arrived
TypeString
RequiredNo
wp10_image
DescriptionAttach an image to appear in the notification body for Windows 10 push message .
TypeURL
RequiredNo
Errors

Wrong device type value. System does not support this platform .

Wrong input JSON format for `platform` parameter

Wrong device type value. System does not support this platform

Was this article helpful to you? Yes No

How can we help?