Mobile Notification Subscription

This method is a client application request for either subscribing to or canceling mobile notifications for a chat session.

Notes

  • This method should be invoked after invoking the Request Chat method (i.e., the chatId value required for this method is returned in the Request Chat method).

  • Additionally, this method should be invoked when its device token is changed.

  • The client application may also opt to stop receiving mobile notifications by using this API method
    with an empty JSON body: {}

Request Parameters

The mobile application will specify one of the following parameters, depending on the application’s
operating system and used notification framework.

Parameter NameDescription
ios_apns_device_tokenThe iOS application using native APNs
ios_app_bundle_idFor iOS devices using native APNs, this parameter is required and is used as the APNs topic
ios_firebase_device_tokenThe iOS application using Firebase notifications
android_firebase_device_tokenThe android application using Firebase notifications

Returns

CodeDescription
200Names of configured services with current status

Errors

CodeDescription
403Forbidden
406Not acceptable: Too many parameters/corresponding notifications are not configured for the Messaging/Chat entry
Language
Credentials
Bearer
Click Try It! to start a request and see the response here!