Cancel a call invitation
Cancel an unanswered call invitation as the caller.
While an outgoing invitation remains unanswered, the caller can abort the attempt by calling signalingCancel().
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
invitation | OpenIMSignalingInvitationInfo | Yes | The complete invitation object preserved from when the call was initiated. |
Supply the original invitation retained during call initiation. Ensure roomID matches the active outgoing invitation.
Code example
import { signalingCancel } from '@/uni_modules/unix-openim-sdk'
await signalingCancel({ invitation })Return value
The Promise resolves with void once the cancellation signal is submitted to OpenIMServer.
State changes after the call
A resolved Promise indicates that the cancellation request completed successfully. The caller client should immediately terminate the outgoing ringing view indexed by roomID and release any reserved audio/video resources. Promise resolution does not guarantee that callee devices have processed the cancellation; for handling incoming cancellation events on callee devices, see Handle call events.
Cancellation applies strictly to unanswered invitations. Once a call is answered and active, invoke Hang up a call instead.
Was this page helpful?