Incoming Call

Display and manage incoming voice and video calls with accept/decline controls using the CometChatIncomingCall component.

Render the incoming call UI with accept and decline actions.

When to use this

• You need to handle incoming audio/video calls.
• You want a default accept/decline screen.
• You need to customize call handling.

Prerequisites

• CometChat React UI Kit v6 installed: @cometchat/chat-uikit-react.
• @cometchat/calls-sdk-javascript installed.
• CometChatUIKit.init() and CometChatUIKit.login() complete before rendering.

Quick start

1. Add the component to your UI.

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";

<CometChatIncomingCall />;

What this does: Renders the minimal version of the component.

2. Verify the component renders after init() and login().

Core concepts

• Mount CometChatIncomingCall at the app root.
• Use onAccept and onDecline to customize behavior.

Implementation

AI Agent Component Spec

• Package: @cometchat/chat-uikit-react
• Import: import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
• Minimal JSX: <CometChatIncomingCall /> — auto-detects incoming calls when mounted at app root
• Required setup: CometChatUIKit.init(UIKitSettings) then CometChatUIKit.login("UID") + @cometchat/calls-sdk-javascript installed
• Key props: onAccept (callback), onDecline (callback), call (CometChat.Call), disableSoundForCalls (boolean), callSettingsBuilder (function)
• CSS class: .cometchat-incoming-call
• Events: ccCallRejected, ccCallAccepted, ccCallEnded

Overview

What you’re changing: Overview. Where to change it: Component props or CSS as shown below. Default behavior: UI Kit defaults. Override: Use the examples in this section. Verify: The UI reflects the change shown below.

The Incoming call is a Component that serves as a visual representation when the user receives an incoming call, such as a voice call or video call, providing options to answer or decline the call.

The Incoming Call is comprised of the following base components:

Components	Description
cometchat-list-item	This component’s view consists of avatar, status indicator , title, and subtitle. The fields are then mapped with the SDK’s user, group class.
cometchat-button	This component represents a button with optional icon and text.
cometchat-avatar	This component component displays an image or user’s avatar with fallback to the first two letters of the username.

Before using this component: Ensure CometChatUIKit.init(UIKitSettings) has completed and the user is logged in via CometChatUIKit.login("UID"). See React.js Integration.

Usage

What you’re changing: Usage. Where to change it: Component props or CSS as shown below. Default behavior: UI Kit defaults. Override: Use the examples in this section. Verify: The UI reflects the change shown below.

Integration

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return <CometChatIncomingCall />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return <CometChatIncomingCall />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

Actions

Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.

1. onAccept

onAccept is triggered when you click the accept button of the Incoming Call component. You can override this action using the following code snippet.

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnAccept = () => {
    console.log("custom on accept action");
  };

  return <CometChatIncomingCall onAccept={handleOnAccept} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnAccept = () => {
    console.log("custom on accept action");
  };

  return <CometChatIncomingCall onAccept={handleOnAccept} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

2. onDecline

onDecline is triggered when you click the Decline button of the Incoming Call component. You can override this action using the following code snippet.

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnDecline = () => {
    console.log("your custom on decline action");
  };

  return <CometChatIncomingCall onDecline={handleOnDecline} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnDecline = () => {
    console.log("your custom on decline action");
  };

  return <CometChatIncomingCall onDecline={handleOnDecline} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

3. onError

This action doesn’t change the behavior of the component but rather listens for any errors that occur in the Incoming Call component.

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnError = (error: CometChat.CometChatException) => {
    console.log("your custom on error action", error);
  };

  return <CometChatIncomingCall onError={handleOnError} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const handleOnError = (error) => {
    console.log("your custom on error action", error);
  };

  return <CometChatIncomingCall onError={handleOnError} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

---

Filters

You can set CallSettingsBuilder in the Incoming Call Component to customise the calling experience. To know more about the filters available please refer to CallSettingsBuilder.

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getCallSettingsBuilder = (call: CometChat.Call) => {
    return new CometChatCalls.CallSettingsBuilder()
      .setIsAudioOnlyCall(
        call?.getType() === CometChatUIKitConstants.MessageTypes.audio
          ? true
          : false
      )
      .build();
  };

  return <CometChatIncomingCall callSettingsBuilder={getCallSettingsBuilder} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getCallSettingsBuilder = (call) => {
    return new CometChatCalls.CallSettingsBuilder()
      .setIsAudioOnlyCall(
        call?.getType() === CometChatUIKitConstants.MessageTypes.audio
          ? true
          : false
      )
      .build();
  };

  return <CometChatIncomingCall callSettingsBuilder={getCallSettingsBuilder} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

Events

Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.

The list of events emitted by the Incoming Call component is as follows.

Event	Description
ccCallRejected	This event is triggered when the initiated call is rejected by the receiver.
ccCallAccepted	This event is triggered when the initiated call is accepted by the receiver.
ccCallEnded	This event is triggered when the initiated call successfully ends.

Add Listener

const ccCallRejected = CometChatCallEvents.ccCallRejected.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);

const ccCallAccepted = CometChatCallEvents.ccCallAccepted.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);

const ccCallEnded = CometChatCallEvents.ccCallEnded.subscribe(
  (call: CometChat.Call) => {
    //Your Code
  }
);

What this does: Shows the code for this step.

---

Remove Listener

ccCallRejected?.unsubscribe();

ccCallAccepted?.unsubscribe();

ccCallEnded?.unsubscribe();

What this does: Shows the code for this step.

---

Customization

What you’re changing: Customization. Where to change it: Component props or CSS as shown below. Default behavior: UI Kit defaults. Override: Use the examples in this section. Verify: The UI reflects the change shown below.

To fit your app’s design requirements, you can customize the appearance of the Incoming Call component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style

Using CSS you can customize the look and feel of the component in your app like the color, size, shape, and fonts.

Example:

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return <CometChatIncomingCall />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return <CometChatIncomingCall />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

CSS

.cometchat-incoming-call {
  display: flex;
  width: 555px;
  padding: 30.833px;
  flex-direction: column;
  align-items: center;
  gap: 24.667px;
  flex-shrink: 0;
  border-radius: 18.5px;
  border: 1.542px solid #aa9ee8;
  background: #fff;
  box-shadow: 0px 18.5px 24.667px -6.167px rgba(16, 24, 40, 0.08), 0px 6.167px
      9.25px -3.083px rgba(16, 24, 40, 0.03);
}

.cometchat-incoming-call .cometchat-list-item {
  width: 100%;
}

.cometchat-incoming-call .cometchat-incoming-call__button-group {
  justify-content: center;
}

.cometchat-incoming-call__button-decline,
.cometchat-incoming-call__button-accept {
  background-color: white;
  border-radius: 12px;
  border: 1.5px solid #dcdcdc;
}

.cometchat-incoming-call__button-decline .cometchat-button:hover,
.cometchat-incoming-call__button-decline .cometchat-button {
  background-color: white;
  background-color: white;
  border-radius: 12px;
  border: 1.5px solid #dcdcdc;
}

.cometchat-incoming-call__button-accept .cometchat-button:hover,
.cometchat-incoming-call__button-accept .cometchat-button {
  background-color: #6852d6;
  color: white;
}

.cometchat-incoming-call__button-decline .cometchat-button__text {
  color: #f44649;
  font: 500 21px/120% roboto;
  font-style: normal;
}

.cometchat-incoming-call__button-accept .cometchat-button__text {
  color: #fff;
  font: 500 21px/120% roboto;
  font-style: normal;
}

.cometchat-incoming-call__button-decline .cometchat .cometchat-button::before,
.cometchat-incoming-call__button-accept .cometchat .cometchat-button::before {
  content: url("../assets/call-decline.svg");
  width: 37px;
  height: 37px;
  flex-shrink: 0;
}

.cometchat-incoming-call__button-accept .cometchat .cometchat-button::before {
  content: url("../assets/call-accept.svg");
}

.cometchat-incoming-call__avatar,
.cometchat-incoming-call__avatar .cometchat-avatar {
  display: flex;
  width: 123.333px;
  height: 123.333px;
  justify-content: center;
  align-items: center;
  border-radius: 24.667px;
  background: #aa9ee8;
}

.cometchat-incoming-call__avatar .cometchat-avatar__image {
  border-radius: 24.667px;
}

.cometchat-incoming-call__avatar .cometchat-avatar__text {
  color: #fff;
  text-align: center;
  font: 500 21px/120% roboto;
  font-style: normal;
}

.cometchat-incoming-call .cometchat-list-item__body {
  flex-direction: column-reverse;
  gap: 20px;
  background: #fff;
}

.cometchat-incoming-call .cometchat-list-item__body-title {
  color: #141414;
}

.cometchat-incoming-call .cometchat-list-item__title-container {
  text-align: center;
  gap: 6px;
}

.cometchat-list-item__body-subtitle {
  justify-content: center;
}

What this does: Shows the code for this step.

Functionality

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

Here is a code snippet demonstrating how you can customize the functionality of the Incoming Call component.

TypeScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return (
    <CometChatIncomingCall
      disableSoundForCalls={true}
    />
  );
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  return (
    <CometChatIncomingCall
      disableSoundForCalls={true}
    />
  );
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

Below is a list of customizations along with corresponding code snippets

Property	Description	Code
Call	The CometChat call object used to initialize and display the incoming call component.	call={callObject}
Disable sound	Disables the sound for incoming calls.	disableSoundForCalls={true}
Custom sound	Specifies a custom sound to play for incoming calls.	customSoundForCalls='Your Custom Sound For Calls'

---

Advanced

For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.

---

SubtitleView

Property subtitleView is a function that renders a JSX element to display the subtitle view.

TypeScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getSubtitleView = (call: CometChat.Call): JSX.Element => {
    /** Return custom subtitle view */
  };

  return <CometChatIncomingCall subtitleView={getSubtitleView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getSubtitleView = (call) => {
    /** Return custom subtitle view */
  };

  return <CometChatIncomingCall subtitleView={getSubtitleView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

LeadingView

Property leadingView is a function that renders a JSX element to display the leading view.

The customized call interface is displayed below.

Use the following code to achieve the customization shown above.

TypeScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatAvatar, CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getLeadingView = (call: CometChat.Call) => {
        return (
            <div>
                <CometChatAvatar name={call?.getCallInitiator()?.getName()} image={call?.getCallInitiator()?.getAvatar()} />
            </div>
        )
    };

  return <CometChatIncomingCall leadingView={getLeadingView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatAvatar, CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getLeadingView = (call) => {
        return (
            <div>
                <CometChatAvatar name={call?.getCallInitiator()?.getName()} image={call?.getCallInitiator()?.getAvatar()} />
            </div>
        )
    };

  return <CometChatIncomingCall leadingView={getLeadingView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

CSS

.cometchat-incoming-call__avatar {
  display: none;
}

What this does: Shows the code for this step.

TitleView

Property titleView is a function that renders a JSX element to display the title view.

The customized call interface is displayed below.

Use the following code to achieve the customization shown above.

TypeScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getTitleView = (call: CometChat.Call) => {
        return (
            <div className="incoming-call__title-wrapper">
                {call?.getCallInitiator()?.getName()}
                <div className="incoming-call__tag">
                    <div className="incoming-call__tag-icon" />
                    {call.getCallInitiator()?.getRole()}
                </div>
            </div>
        )
    };

  return <CometChatIncomingCall titleView={getTitleView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getTitleView = (call) => {
        return (
            <div className="incoming-call__title-wrapper">
                {call?.getCallInitiator()?.getName()}
                <div className="incoming-call__tag">
                    <div className="incoming-call__tag-icon" />
                    {call.getCallInitiator()?.getRole()}
                </div>
            </div>
        )
    };

  return <CometChatIncomingCall titleView={getTitleView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

CSS

.incoming-call__title-wrapper {
  display: flex;
  width: 370px;
  height: 37px;
  padding: 2px 10px;
  align-items: center;
  gap: 10px;
  color: #141414;
  font: 700 24px Roboto;
}

.incoming-call__tag {
  display: flex;
  height: 30.036px;
  padding: 2.002px 6.007px;
  justify-content: center;
  align-items: center;
  gap: 6.007px;
  border-radius: 14.017px;
  background: #09C26F;
  color: #FFF;
  font: 600 12px Roboto;
}

.incoming-call__tag-icon {
  background-image: url("<relative path to your icon>");
  background-size: contain;
  height: 20px;
  width: 20px;
}

What this does: Shows the code for this step.

TrailingView

Property trailingView is a function that renders a JSX element to display the trailing view.

The customized call interface is displayed below.

Use the following code to achieve the customization shown above.

TypeScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getTrailingView = (call: CometChat.Call) => {
        return (
            <div className="incoming-call__avatar">
                <div className="incoming-call__avatar-icon" />
                {call.getCallInitiator()?.getRole()}
            </div>
        )
    };

  return <CometChatIncomingCall trailingView={getTrailingView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getTrailingView = (call) => {
        return (
            <div className="incoming-call__avatar">
                <div className="incoming-call__avatar-icon" />
                {call.getCallInitiator()?.getRole()}
            </div>
        )
    };

  return <CometChatIncomingCall trailingView={getTrailingView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

CSS

.incoming-call__avatar {
  display: flex;
  height: 62px;
  padding: 1px 3px;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  gap: 3px;
  border-radius: 7px;
  background: #AA9EE8;
  color: #FFF;
  font: 600 10px Roboto;
}

.incoming-call__avatar-icon {
  background-image: url("<relative path to your icon");
  height: 28px;
  width: 28px;
  background-size: contain;
}

What this does: Shows the code for this step.

ItemView

Property itemView is a function that renders a JSX element to display the item view.

The customized call interface is displayed below.

Use the following code to achieve the customization shown above.

TypeScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatAvatar, CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getItemView = (call: CometChat.Call) => {
        return (
            <div className="incoming-call__itemview">
                <CometChatAvatar name={call?.getCallInitiator()?.getName()} image={call?.getCallInitiator()?.getAvatar()} />
                <div>
                    <div className="incoming-call__itemview-title">
                        {call?.getCallInitiator()?.getName()}
                    </div>
                    <div className="incoming-call__itemview-subtitle">
                        {"Incoming " + call.getType() + " call"}
                    </div>
                </div>
            </div>
        )
    };

  return <CometChatIncomingCall itemView={getItemView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

JavaScript

import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatAvatar, CometChatIncomingCall } from "@cometchat/chat-uikit-react";
import React from "react";

const IncomingCallsDemo = () => {
  const getItemView = (call) => {
        return (
            <div className="incoming-call__itemview">
                <CometChatAvatar name={call?.getCallInitiator()?.getName()} image={call?.getCallInitiator()?.getAvatar()} />
                <div>
                    <div className="incoming-call__itemview-title">
                        {call?.getCallInitiator()?.getName()}
                    </div>
                    <div className="incoming-call__itemview-subtitle">
                        {"Incoming " + call.getType() + " call"}
                    </div>
                </div>
            </div>
        )
    };

  return <CometChatIncomingCall itemView={getItemView} />;
};

export default IncomingCallsDemo;

What this does: Shows the code for this step.

CSS

.incoming-call__itemview {
  display: flex;
  flex-direction: column;
  justify-content: center;
  align-items: center;
  gap: 20px;
  align-self: stretch;
}

.incoming-call__itemview .cometchat-avatar,
.incoming-call__itemview .cometchat-avatar__image {
  height: 90px;
  width: 90px;
  border-radius: 24px;
}

.incoming-call__itemview .cometchat-avatar__text {
  color: #FFF;
  text-align: center;
  font: 700 32px Roboto
}

.incoming-call__itemview-title {
  color: #141414;
  text-align: center;
  font: 700 24px Roboto;
}

.incoming-call__itemview-subtitle {
  color: var(--Color-Text-Color-Text-Secondary, #727272);
  font: 400 16px Roboto;
}

What this does: Shows the code for this step.

Common Failure Modes

Symptom	Cause	Fix
Component doesn’t render	CometChatUIKit.init() not called or not awaited	Ensure init completes before rendering. See Methods
Component renders but no incoming call shown	User not logged in or no active incoming call	Call CometChatUIKit.login("UID") after init. The component auto-detects incoming calls.
Callback not firing	Wrong prop name or signature	Check the Actions section for exact prop name and parameter types
Custom view not appearing	Returning null or undefined from view prop	Ensure view function returns valid JSX
No ringtone playing	disableSoundForCalls set to true or custom sound path invalid	Set disableSoundForCalls={false} and verify custom sound file path
SSR hydration error	Component uses browser APIs on server	Wrap in useEffect or dynamic import with ssr: false. See Next.js Integration

---

Customization matrix

What you want to change	Where	Property/API	Example
Handle accept	CometChatIncomingCall	onAccept	onAccept={() => ...}
Handle decline	CometChatIncomingCall	onDecline	onDecline={() => ...}
Disable sounds	CometChatIncomingCall	disableSoundForCalls	disableSoundForCalls={true}

Common pitfalls and fixes

Symptom	Cause	Fix
Incoming UI not shown	Component not mounted	Render CometChatIncomingCall at root
Calls not available	Calls SDK missing	Install @cometchat/calls-sdk-javascript
Init/login missing	SDK not initialized	Call CometChatUIKit.init() and login()

FAQ

Where should I mount it? At the app root so it can listen globally.

Can I customize accept/decline? Yes. Use onAccept and onDecline.

Next steps

• Outgoing Call
• Call Buttons
• Call Features