sip.js.subscriber.unsubscribe.md

Home > sip.js > Subscriber > unsubscribe

Subscriber.unsubscribe() method

Unsubscribe from event notifications.

Signature:

unsubscribe(options?: SubscriptionUnsubscribeOptions): Promise<void>;

Parameters

Parameter	Type	Description
options	SubscriptionUnsubscribeOptions

Returns:

Promise<void>

Remarks

If the subscription state is SubscriptionState.Subscribed, sends an in dialog SUBSCRIBE request with expires time of zero (an un-subscribe) and terminates the subscription. Otherwise a noop.