Mobile Notification Subscription

post

https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/{chatId}/notifications

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 Name	Description
ios_apns_device_token	The iOS application using native APNs
ios_app_bundle_id	For iOS devices using native APNs, this parameter is required and is used as the APNs topic
ios_firebase_device_token	The iOS application using Firebase notifications
android_firebase_device_token	The android application using Firebase notifications

Returns

Code	Description
200	Names of configured services with current status

Errors

Code	Description
403	Forbidden
406	Not acceptable: Too many parameters/corresponding notifications are not configured for the Messaging/Chat entry

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

chatId

string

required

The current chat session ID. The value of this variable is returned in the body of a successful invocation of the "Request Chat" method.

Query Params

tenantUrl

string

Identifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).

Body Params

Headers

Content-Type

string

Authorization

string

appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. clientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to "WebChat", HTTP cookies will be used for client identification.

User-Agent

string

Response

200OK