Resource.subscribe

Revision as of 16:56, 3 October 2012

resource.subscribe

resource.subscribe is a message sent by a module requesting a subscription to a specified resource and event.

Parameters

event 

Keyword indicating the event: dialog (subscription to call state events), message-summary (message waiting subscription)

operation 

Keyword indicating the request: subscribe (request a subscription), unsubscribe (request to unsubscribe from event)

expires 

Integer indicating the subscription duration (if operation is subscribe). If 0, the subscription won't expire

subscriber 

The requestor

notifier 

The resource to subscribe to

notifyto 

The URI used as destination when notifying

data 

Data used by protocol

Return

A processor of this message should set the error, reason or code parameters of the message and return false if the subscriber is not allowed to subscribe to the notifier's event.