Skip to content

Push with API

Message publishing API supports the following scenarios:

  • Push notification from a Push Template - This approach is the simplest and yet provides the most flexibility when it comes to  identifying a dynamic audience of who will be receiving the notification, creating custom, personalized content for each recipient and configuring numerous visual and audible effects. To send out push notifications for a Push Template using the API, make sure to start with defining a Push Template first. For more information see the About Push Templates section of the guide. API Example.
  • Basic push notification - It is the simplest form of a push notification. It is sent to a channel and all devices registered with the channel will be receiving the notification. The notification message must contain headers which control the appearance of the notification on the devices. API Example.
  • Push notification delivered to devices grouped by the OS - With this type delivery, a notification is sent to all devices of a specific operating system (or a combination of).  This includes delivery to Android, iOS or both. API Example.
  • Push notification delivered to specific devices - This delivery type allows push notification delivery to individual devices. API Example
  • Delayed publishing - For all scenarios described above a push notification request can be configured to be executed at a later time. API Example.

Publishes a push notification to a channel. Headers must be added to the publishOptions argument. The deliveryOptions argument can be used to:

  1. Designate the message as "push notification only" or both a push notification and a pub/sub message.
  2. Singlecast publishing - set a list of devices which should be receiving the notification.
  3. Broadcast publishing - identify operating systems of the registered devices which should be receiving the notification.
  4. Publish the message at a later time (delayed publishing).
  5. Specify that the message should be republished multiple times (repeated publishing).
// These methods publish a message to the specified channel with publish or/and delivery options
// Use these methods to send additional message headers (including specialized headers for push notifications), publisher ID and channel's subtopic

- (void)publishWithChannelName:(NSString * _Nonnull)channelName message:(id _Nonnull)message responseHandler:^(MessageStatus * _Nonnull)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;

- (void)publishWithChannelName:(NSString * _Nonnull)channelName message:(id _Nonnull)message publishOptions:(PublishOptions * _Nonnull)publishOptions responseHandler:^(MessageStatus * _Nonnull)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;

- (void)publishWithChannelName:(NSString * _Nonnull)channelName message:(id _Nonnull)message deliveryOptions:(DeliveryOptions * _Nonnull)deliveryOptions responseHandler:^(MessageStatus * _Nonnull)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;

- (void)publishWithChannelName:(NSString * _Nonnull)channelName message:(id _Nonnull)message publishOptions:(PublishOptions * _Nonnull)publishOptions deliveryOptions:(DeliveryOptions * _Nonnull)deliveryOptions responseHandler:^(MessageStatus * _Nonnull)responseHandler errorHandler:^(Fault * _Nonnull)errorHandler;
// These methods publish a message to the specified channel with publish or/and delivery options
// Use these methods to send additional message headers (including specialized headers for push notifications), publisher ID and channel's subtopic

func publish(channelName: String, message: Any, responseHandler: ((MessageStatus) -> Void)!, errorHandler: ((Fault) -> Void)!)

func publish(channelName: String, message: Any, publishOptions: PublishOptions, responseHandler: ((MessageStatus) -> Void)!, errorHandler: ((Fault) -> Void)!)

func publish(channelName: String, message: Any, deliveryOptions: DeliveryOptions, responseHandler: ((MessageStatus) -> Void)!, errorHandler: ((Fault) -> Void)!)

func publish(channelName: String, message: Any, publishOptions: PublishOptions, deliveryOptions: DeliveryOptions, responseHandler: ((MessageStatus) -> Void)!, errorHandler: ((Fault) -> Void)!)

Return value

MessageStatus- a data structure with the assign message ID which can be used to obtain push notification status

Errors

The following errors may occur during the message publishing API call. See the Error Handling section for details on how to retrieve the error code when the server returns an error:

Error Code
Description
5003
Invalid repeatExpiresAt date in delivery options.
5007
User does not have the permission to publish messages
5030
Invalid publishAt date in the delivery options.