Resource.notify - Revision history

Dana: /* Return */

2013-01-21T15:22:32Z

‎Return

Dana at 15:17, 21 January 2013

2013-01-21T15:17:45Z

Dana at 13:10, 12 October 2012

2012-10-12T13:10:12Z

Dana: 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..."

2012-10-12T13:08:33Z

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..."

New page

'''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

← Older revision		Revision as of 15:22, 21 January 2013
Line 50:		Line 50:
	'''See also'''		'''See also'''

−	* [[sip.<methodname>]]	+	* [[SIP Generic Message\|sip.<methodname>]]

← Older revision		Revision as of 15:17, 21 January 2013
Line 46:		Line 46:

	None expected		None expected
		+
		+
		+	'''See also'''
		+
		+	* [[sip.<methodname>]]

@@ Line 4: / Line 4: @@
 ;event
-:    Keyword indicating the event: dialog (subscription to call state events), message-summary (message waiting subscription)
+: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
+:Optional integer indicating the remaining time of the subscription
 ;subscriber
-:    The entity that requested the subscription
+:The entity that requested the subscription
 ;notifier
-:    The resource (user) making the notification
+:The resource (user) making the notification
 ;notifyto
-:    URI used as destination for the notification
+:URI used as destination for the notification
 ;data
-:    Data used by protocol
+:Data used by protocol
 ;notifyseq
-:    Integer indicating the sequence number of the notification within the subscription given by notifier and event
+: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
+:Keyword indicating the subscription state: pending/active/terminated
 ;terminatereason
-:    Optional subscription termination reason if subscriptionstate is terminated
+: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
+:The id of the dialog if any
 ;dialog.callid
-:    The dialog identifier
+:The dialog identifier
 ;dialog.localtag
-:    The local tag component of the dialog identifier
+:The local tag component of the dialog identifier
 ;dialog.remotetag
-:    The remote tag component of the dialog identifier
+:The remote tag component of the dialog identifier
 ;dialog.direction
-:    Keyword indicating the call direction from the Yate's point of view: incoming/outgoing
+:Keyword indicating the call direction from the Yate's point of view: incoming/outgoing
 ;dialog.remoteuri
-:    The notifier dialog peer's URI
+:The notifier dialog peer's URI
 ;dialog.state
-:   Keyword indicating the call state: trying/confirmed/early/rejected/terminated
+:Keyword indicating the call state: trying/confirmed/early/rejected/terminated
 ;message-summary.voicenew
-:    Optional integer specifying the number of unread (new) voice messages
+:Optional integer specifying the number of unread (new) voice messages
 ;message-summary.voiceold
-:    Optional integer specifying the number of read (old) voice messages
+:Optional integer specifying the number of read (old) voice messages
 ===Return===
 None expected