start()

Note: This API is supported from version 6.5.1.

The start() API initiates a call to a specified user using their unique ID anywhere within the application. You can optionally include custom attributes for the call and a callback function to handle the success or failure of the call initiation.

Parameters:

  • id (String) (Optional): The unique ID of the chat to call.
  • displayActiveCall (Boolean): Opens the call screen if there is an ongoing call.
  • attributes (SalesIQConversationAttributes) (Optional): Attributes to customize the call, including the user's name, additional info, or display picture metadata.

Example

CopiedSalesIQConversationAttributes attributes = SalesIQConversationAttributes(
  name: "Zylker",
  additionalInfo: "Technical team",
  displayPicture:
      "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTmcpiyts9M3zpanvqrDoltvPffjbLIborLnHG7oaZVx2c_yeLzDBqKCeBSkvJizNfntWA&usqp=CAU",
  departments: [
    SalesIQDepartment.fromName("Tech team",
        communicationMode: CommunicationMode.chatAndCall)
  ],
);

SalesIQConversation? conversation = await ZohoSalesIQCalls.start(
  id: 'order_id_001',
  displayActiveCall: true,
  attributes: attributes,
);