Resource.notify
From Yate Documentation
(Difference between revisions)
(Created page with "'''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...") |
(→Return) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 4: | Line 4: | ||
;event | ;event | ||
| − | : | + | :Keyword indicating the event: dialog (subscription to call state events), message-summary (message waiting subscription) |
;expires | ;expires | ||
| − | : | + | :Optional integer indicating the remaining time of the subscription |
;subscriber | ;subscriber | ||
| − | : | + | :The entity that requested the subscription |
;notifier | ;notifier | ||
| − | : | + | :The resource (user) making the notification |
;notifyto | ;notifyto | ||
| − | : | + | :URI used as destination for the notification |
;data | ;data | ||
| − | : | + | :Data used by protocol |
;notifyseq | ;notifyseq | ||
| − | : | + | :Integer indicating the sequence number of the notification within the subscription given by notifier and event |
;subscriptionstate | ;subscriptionstate | ||
| − | : | + | :Keyword indicating the subscription state: pending/active/terminated |
;terminatereason | ;terminatereason | ||
| − | : | + | :Optional subscription termination reason if subscriptionstate is terminated |
Event specific parameters are prefixed by the event name: | Event specific parameters are prefixed by the event name: | ||
;dialog.id | ;dialog.id | ||
| − | : | + | :The id of the dialog if any |
;dialog.callid | ;dialog.callid | ||
| − | : | + | :The dialog identifier |
;dialog.localtag | ;dialog.localtag | ||
| − | : | + | :The local tag component of the dialog identifier |
;dialog.remotetag | ;dialog.remotetag | ||
| − | : | + | :The remote tag component of the dialog identifier |
;dialog.direction | ;dialog.direction | ||
| − | : | + | :Keyword indicating the call direction from the Yate's point of view: incoming/outgoing |
;dialog.remoteuri | ;dialog.remoteuri | ||
| − | : | + | :The notifier dialog peer's URI |
;dialog.state | ;dialog.state | ||
| − | : | + | :Keyword indicating the call state: trying/confirmed/early/rejected/terminated |
;message-summary.voicenew | ;message-summary.voicenew | ||
| − | : | + | :Optional integer specifying the number of unread (new) voice messages |
;message-summary.voiceold | ;message-summary.voiceold | ||
| − | : | + | :Optional integer specifying the number of read (old) voice messages |
===Return=== | ===Return=== | ||
None expected | None expected | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | * [[SIP Generic Message|sip.<methodname>]] | ||
Latest revision as of 18:22, 21 January 2013
resource.notify is a message sent by a module to notify a resource event state change or a subscription termination
[edit] 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
[edit] Return
None expected
See also
