sip.js.invitation.reject.md
September 26, 2022 ยท View on GitHub
Home > sip.js > Invitation > reject
Invitation.reject() method
Reject the invitation.
Signature:
reject(options?: InvitationRejectOptions): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | InvitationRejectOptions | Options bucket. |
Returns:
Promise<void>
Remarks
Replies to the INVITE request with a 4xx, 5xx, or 6xx final response. Resolves once the response sent, otherwise rejects.
The expectation is that this method is used to reject an INVITE request. That is indeed the case - a call to progress followed by reject is a typical way to "decline" an incoming INVITE request. However it may also be called after calling accept (but only before it completes) which will reject the call and cause accept to reject.