OpenIMSDKDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · WASM
SDKsWASMEnterprise

Restore a pending call invitation

Restore a call invitation that remained pending when the application started or returned to the foreground.

Copy

getSignalingInvitationInfoStartApp() takes no parameters. Use it to check whether an invitation still needs attention when the application starts or resumes:

const { data } = await openimsdk.getSignalingInvitationInfoStartApp();

if (data.invitation?.roomID) {
  restoreIncomingCall(data.invitation, data.offlinePushInfo);
}

Return result

FieldTypeDescription
invitationSignalingInvitation or nullComplete invitation data still awaiting action, or null when there is no recoverable invitation.
offlinePushInfoOfflinePushOffline push information carried by the invitation, which can be used to restore the incoming-call presentation.

When the Promise resolves, data is a SignalingStartupInvitationResult. The query reads only the invitation that is still pending at that moment; it does not trigger a call event. Restore the incoming-call interface only when invitation is not null and contains a valid roomID. Continue listening for cancellation, timeout, acceptance, and hang-up afterward. For the complete flow, see Call events.