Skip to main content
Show the outgoing call screen after initiating a call.

​
When to use this

  • You need to initiate voice or video calls.
  • You want a default outgoing call UI.
  • You need to handle call cancellation.

​
Prerequisites

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

​
Quick start

  1. Add the component to your UI.
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatOutgoingCall, CometChatUIKitConstants } from "@cometchat/chat-uikit-react";

const callObject = new CometChat.Call(
  "uid",
  CometChatUIKitConstants.MessageTypes.audio,
  CometChatUIKitConstants.MessageReceiverType.user
);
const call = await CometChat.initiateCall(callObject);

<CometChatOutgoingCall call={call} />;
What this does: Renders the minimal version of the component.
  1. Verify the component renders after init() and login().

​
Core concepts

  • call prop is required.
  • Use onCallCanceled for cancel handling.

​
Implementation

  • Package: @cometchat/chat-uikit-react
  • Import: import { CometChatOutgoingCall } from "@cometchat/chat-uikit-react";
  • Minimal JSX: <CometChatOutgoingCall call={callObject} /> — requires a CometChat.Call object from CometChat.initiateCall()
  • Required setup: CometChatUIKit.init(UIKitSettings) then CometChatUIKit.login("UID") + @cometchat/calls-sdk-javascript installed
  • Key props: call (CometChat.Call, required), onCallCanceled (callback), disableSoundForCalls (boolean), titleView (JSX), subtitleView (JSX)
  • CSS class: .cometchat-outgoing-call

​
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 outgoing call component is a visual representation of a user-initiated call, whether it’s a voice or video call. It serves as an interface for managing outgoing calls, providing users with essential options to control the call experience. This component typically includes information about the call recipient, call controls for canceling the call, and feedback on the call status, such as indicating when the call is in progress.
The Outgoing Call is comprised of the following components:
ComponentsDescription
CometChat ButtonThis component represents a button with optional icon and text.
CometChat AvatarThis 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

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

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid"; //TODO: replace with actual UID of the call receiver

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  return call ? <CometChatOutgoingCall call={call} /> : null;
};

export default OutgoingCallDemo;
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. onCallCanceled
The onCallCanceled event gets activated when the cancel button is clicked. It does not have a default behavior. However, you can override its behavior using the following code snippet. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  const cancelCall = () => {
    //your custom cancel call click actions
    CometChat.endCall(call!.getSessionId()).then(() => {
      setCall(undefined);
    });
  };
  return call ? (
    <CometChatOutgoingCall call={call} onCallCanceled={cancelCall} />
  ) : null;
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
2. onError
This action doesn’t change the behavior of the component but rather listens for any errors that occur in the Outgoing Call component. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  function handleOnError(error: CometChat.CometChatException) {
    //Your Custom Error Actions
    console.log(error);
  }

  return call ? (
    <CometChatOutgoingCall call={call} onError={handleOnError} />
  ) : null;
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.

​
Filters

Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of Chat SDK. The Outgoing Call component does not have any exposed filters.

​
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 Outgoing Call component does not have any exposed filters.

​
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 Outgoing 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 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
  OutgoingCallStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  return call ? <CometChatOutgoingCall call={call} /> : null;
};

export default OutgoingCallDemo;
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 Outgoing Call component. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  return call ? (
    <CometChatOutgoingCall call={call} disableSoundForCalls={false} />
  ) : null;
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
Below is a list of customizations along with corresponding code snippets
PropertyDescriptionCode
CallThe CometChat call object used to set up and launch the outgoing call.call={call}
Disable SoundDisables the sound of outgoing calls.disableSoundForCalls={false}
Custom SoundSpecifies a custom sound to play for outgoing 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.
TitleView
This prop renders the custom title view for the outgoing call. Use this to override the existing title of user name from the outgoing call. The customized chat interface is displayed below.
Use the following code to achieve the customization shown above. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  const getTitleView = (call: Call) => {
    return (
      <div className="outgoing-call__title">
        {call.getCallInitiator().getName()} {" <> "} {call.getCallReceiver().getName()}
      </div>
    );
  };

  return (
    call && <CometChatOutgoingCall call={call} titleView={getTitleView(call)} />
  );
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
SubtitleView
This prop renders the custom sub title view for the outgoing call. Use this to override the existing sub title text from the outgoing call. The customized chat interface is displayed below.
Use the following code to achieve the customization shown above. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  const getSubtitleView = (call: Call) => {
    return (
      <div className="outgoing-call__subtitle">
        <div className="outgoing-call__subtitle-icon" />
        {"Calling..."}
      </div>
    );
  };

  return (
    call && <CometChatOutgoingCall call={call} subtitleView={getSubtitleView(call)} />
  );
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
AvatarView
This prop renders the custom avatar view for the outgoing call. Use this to override the existing avatar image from the outgoing call. The customized chat interface is displayed below.
Use the following code to achieve the customization shown above. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatAvatar,
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  const getAvatarView = (call: CometChat.Call) => {
    return (
      <div className="outgoing-call__avatar">
        <CometChatAvatar
          name={call?.getCallReceiver()?.getName()}
          image={(call?.getCallReceiver() as CometChat.User)?.getAvatar()}
        />
        <div className="outgoing-call__avatar-status" />
      </div>
    );
  };

  return (
    call && <CometChatOutgoingCall call={call} avatarView={getAvatarView(call)} />
  );
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
CancelButtonView
This prop renders the custom cancel-call button view for the outgoing call. Use this to override the existing cancel call button view from the outgoing call. The customized chat interface is displayed below.
Use the following code to achieve the customization shown above. 
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatOutgoingCall,
  CometChatUIKitConstants,
} from "@cometchat/chat-uikit-react";
import React from "react";

const OutgoingCallDemo = () => {
  const [call, setCall] = React.useState<CometChat.Call>();

  React.useEffect(() => {
    const uid = "uid";

    const callObject = new CometChat.Call(
      uid,
      CometChatUIKitConstants.MessageTypes.audio,
      CometChatUIKitConstants.MessageReceiverType.user
    );
    CometChat.initiateCall(callObject)
      .then((c) => {
        setCall(c);
      })
      .catch(console.log);
  }, []);

  const getCancelButtonView = (call: Call) => {
    return (
      <div className="outgoing-call__cancel-button-wrapper">
        <div className="outgoing-call__cancel-button">
          <div className="outgoing-call__cancel-button-icon" />
          {"End Call"}
        </div>
      </div>
    );
  };

  return (
    call && <CometChatOutgoingCall call={call} cancelButtonView={getCancelButtonView(call)} />
  );
};

export default OutgoingCallDemo;
What this does: Shows the code for this step.
SymptomCauseFix
Component doesn’t renderCometChatUIKit.init() not called or not awaitedEnsure init completes before rendering. See Methods
Component renders but shows nothingcall prop not provided or is undefinedPass a valid CometChat.Call object from CometChat.initiateCall()
Callback not firingWrong prop name or signatureCheck the Actions section for exact prop name and parameter types
Custom view not appearingReturning null or undefined from view propEnsure view function returns valid JSX
No ringtone playingdisableSoundForCalls set to true or custom sound path invalidSet disableSoundForCalls={false} and verify custom sound file path
SSR hydration errorComponent uses browser APIs on serverWrap in useEffect or dynamic import with ssr: false. See Next.js Integration

​
Customization matrix

What you want to changeWhereProperty/APIExample
Render outgoing callCometChatOutgoingCallcallcall={call}
Handle cancelCometChatOutgoingCallonCallCanceledonCallCanceled={() => ...}
Disable soundsCometChatOutgoingCalldisableSoundForCallsdisableSoundForCalls={true}

​
Common pitfalls and fixes

SymptomCauseFix
Outgoing UI not shownCall not initiatedCall CometChat.initiateCall() and pass result
Calls not availableCalls SDK missingInstall @cometchat/calls-sdk-javascript
Init/login missingSDK not initializedCall CometChatUIKit.init() and login()

​
FAQ

Do I need to initiate the call? Yes. call must come from CometChat.initiateCall(). How do I cancel a call? Use the onCallCanceled callback.

​
Next steps