API Method: /api/distribution/ios/push-notification
Send push notifications to all registered iOS devices.
The ecosystem for for iOS push notifications is fairly complex, and this method aim to make custom push notification slightly easier when devices are registered through the services such as 23 Video. Still, it's a good idea to read through Apple's documentation and this guide from Boxed Ice on how pushing actually works.
A call to this method can either specify a simple text message parameter for push, or can include a full payload specification for full control of the data push to subscribing devices.
Parameters
| Parameter | Description |
|---|---|
| payload | A properly formated JSON dictiorary matching Apple's specifications. The maximum size allowed for a notification payload is 256 bytes. Whenever this parameter is used, all other parameters are ignored. |
| message | A text message to be sent to the subscribing iOS devices. The maximum size allowed for message is 200 characters. |
| badge | The `badge` parameter to pass on in the payload. See the official documentation for more detail. |
| sound | The `sound` parameter to pass on in the payload. See the official documentation for more detail. |
| photo_id | Send a specific photo_id wrapped in a visual object in the payload. Can be used to go to a specific object in the application when a notification has been engaged. |
| album_id | Send a specific album_id wrapped in a visual object in the payload. Can be used to go to a specific object in the application when a notification has been engaged. |
| liveevent_id | Send a specific liveevent_id wrapped in a visual object in the payload. Can be used to go to a specific object in the application when a notification has been engaged. |
Permission level
The minimum required permission level is:
super
Example XML Response
<response status="ok" permission_level="super"
message="The push notification was successfully snet to all registered iOS devices"
cached="0"/>
Example JSON Response
{
"status": "ok",
"message": "The push notification was successfully snet to all registered iOS devices",
"permission_level":"super",
"cached":"0",
"photo":{},
"p": "1",
"size": "1",
"site": { ... },
"endpoint": "/api/distribution/ios/push-notification"
}
