Skip to main content

@wildix/wms-api-client > NotificationsInput

NotificationsInput interface

Signature:

export interface NotificationsInput 

Properties

Property

Modifiers

Type

Description

broadcastMessage

string

The message for announcing into a conference.

conferenceId

string

The conference ID to which the message will be sent.

confirmationTimeout?

number

(Optional) How many seconds the request should wait for the confirmation after the start.

customRid?

string

(Optional) The custom request ID.

event

string

Information about the event. What happened.

from

string

Information about the source of the notification. For example, the name of the camera.

notificationType

string

Type of the alert that is generated.

origin?

string

(Optional) Indicates the source of the request.

playFrequency?

number

(Optional) How often (each N seconds) a request has to be repeated.

priority?

number

(Optional) The priority of the notification.

queueTimeout?

number

(Optional) How many seconds the queued request should wait for starting processing.