Resource.notify

From Yate Documentation
Jump to: navigation, search

resource.notify is a message sent by a module to notify a resource event state change or a subscription termination

Parameters

event
Keyword indicating the event: dialog (subscription to call state events), message-summary (message waiting subscription)
expires
Optional integer indicating the remaining time of the subscription
subscriber
The entity that requested the subscription
notifier
The resource (user) making the notification
notifyto
URI used as destination for the notification
data
Data used by protocol
notifyseq
Integer indicating the sequence number of the notification within the subscription given by notifier and event
subscriptionstate
Keyword indicating the subscription state: pending/active/terminated
terminatereason
Optional subscription termination reason if subscriptionstate is terminated

Event specific parameters are prefixed by the event name:

dialog.id
The id of the dialog if any
dialog.callid
The dialog identifier
dialog.localtag
The local tag component of the dialog identifier
dialog.remotetag
The remote tag component of the dialog identifier
dialog.direction
Keyword indicating the call direction from the Yate's point of view: incoming/outgoing
dialog.remoteuri
The notifier dialog peer's URI
dialog.state
Keyword indicating the call state: trying/confirmed/early/rejected/terminated
message-summary.voicenew
Optional integer specifying the number of unread (new) voice messages
message-summary.voiceold
Optional integer specifying the number of read (old) voice messages

Return

None expected


See also

Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers