Calls Enums

Note: This API is supported from version 0.0.1.

SalesIQCallStatus

The SalesIQCallStatus enum defines the various states that a call can go through during its lifecycle.

Values:

  • NONE: No active call. The default state.
  • CALLING:  The recipient initiates an outgoing call.
  • RINGING: The call is ringing on the recipient’s end.
  • CONNECTING: The call is in the process of establishing a connection.
  • CONNECTED: The call is successfully connected.
  • ENDED: The call was terminated by either the operator or the recipient.
  • MISSED: The call was not answered by either participant.
  • CANCELLED: The call was canceled before being answered.
  • DECLINED: The recipient declined the call.
  • RECONNECTING: The call was disconnected, and they are trying to reconnect.
  • FAILED: The call could not be established due to errors.
  • QUEUE: The call is in a queue waiting to be answered by an operator.
  • INVALID: Represents an invalid or unrecognized state.

isCallActive:
Indicates whether the current call status is considered active.

Returns

  • true - The call is active/ongoing (e.g., CONNECTED, RINGING, CALLING).
  • false - The call has ended, failed, been declined, cancelled, or is invalid.

CallComponent

The CallComponent enum represents the various components of the call interface that can be toggled for visibility.

Values:

  • OPERATOR_NAME: Manages the visibility of the operator's name on the call screen and in call history. If hidden, the brand name is displayed instead.
  • OPERATOR_IMAGE: Manages the visibility of the operator's profile image on the call screen and in call history. If hidden, the brand's/company's logo is displayed instead.
  • PRE_CHAT_FORM: Manages the visibility of the pre-chat form, which users may be required to fill out before initiating a call.
  • QUEUE_POSITION: Manages the visibility of the call's queue position.

SalesIQCallViewMode

The SalesIQCallViewMode enum represents the type of call status view for the call UI, such as "banner" or "floating".

Values:

  • BANNER: The call status and timer appear as a fixed banner at the top of the screen. This ensures the call details remain visible without covering other parts of the UI.
  • FLOATING: The call status and timer appear in a floating bubble that can be dragged and positioned anywhere within the screen. This gives flexibility while keeping the UI uncluttered.