Calls Enums
Note: These enums are supported from version 8.1.0-beta01.
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.
- INCOMING_CALL: An incoming call is ringing.
- CALLING: The user 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.
- ON_HOLD: The call has been placed on hold.
- NO_RESPONSE: The operator did not answer the call.
- USER_BUSY: The operator is on another call.
- QUEUE: The call is in a queue waiting to be answered by an operator.
- RECONNECTING: The call was disconnected, and they are trying to reconnect.
- CALL_FAILED: The call could not be established due to errors.
- 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, canceled, or is invalid.
CallComponent
The CallComponent enum represents the various components of the call interface that can be toggled for visibility.
Values:
- OperatorName: Manages the visibility of the operator's name on the call screen and in call history. If hidden, the brand name is displayed instead.
- OperatorImage: 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.
- PreChatForm: Manages the visibility of the pre-chat form, which users may be required to fill out before initiating a call.
- QueuePosition: Manages the visibility of the call's queue position.
SalesIQCallAction
The SalesIQCallAction enum defines the possible actions that can be performed on a SalesIQ call.
Values:
- END – The call was terminated by either the operator or the recipient.
- MISS – The call was not answered by either participant.
- CANCEL – The call was canceled before being answered.
- INVITE – The recipient is invited to join the call.
- ACCEPT – The incoming call was answered.
- REJECT – The recipient declined the call.
- INVALID – An unknown or unrecognized call action.