Interface ITask

Optional autoWrapup

data

webCallMap

accept

• accept(): Promise<TaskResponse>

• Answers or accepts an incoming task. Once accepted, the task will be assigned to the agent and trigger a TASK_EVENTS.TASK_ASSIGNED event. The response will contain updated agent contact information as defined in AgentContact.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.accept();
  Copy

cancelAutoWrapupTimer

• cancelAutoWrapupTimer(): void

• Cancels the auto-wrapup timer for the task. This method stops the auto-wrapup process if it is currently active. Note: This is supported only in single session mode. Not supported in multi-session mode.

  Returns void

  void

consult

• consult(consultPayload): Promise<TaskResponse>

• Initiates a consultation with another agent or queue.

  Parameters

  • consultPayload: ConsultPayload

    Consultation details including destination and type

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.consult({ to: "agentId", destinationType: "agent" });
  Copy

consultConference

• consultConference(): Promise<TaskResponse>

• Initiates a consult conference (merge consult call with main call).

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.consultConference();
  Copy

consultTransfer

• consultTransfer(consultTransferPayload?): Promise<TaskResponse>

• Transfers the task after consultation.

  Parameters

  • Optional consultTransferPayload: ConsultTransferPayLoad

    Details for consult transfer (optional)

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.consultTransfer({ to: "agentId", destinationType: "agent" });
  Copy

decline

• decline(): Promise<TaskResponse>

• Declines an incoming task for Browser Login

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.decline();
  Copy

end

• end(): Promise<TaskResponse>

• Ends/terminates the current task.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.end();
  Copy

endConsult

• endConsult(consultEndPayload): Promise<TaskResponse>

• Ends an ongoing consultation.

  Parameters

  • consultEndPayload: ConsultEndPayload

    Details for ending the consultation

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.endConsult({ isConsult: true, taskId: "taskId" });
  Copy

exitConference

• exitConference(): Promise<TaskResponse>

• Exits from an ongoing conference.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.exitConference();
  Copy

hold

• hold(): Promise<TaskResponse>

• Places the current task on hold.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.hold();
  Copy

pauseRecording

• pauseRecording(): Promise<TaskResponse>

• Pauses the recording for current task.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.pauseRecording();
  Copy

resume

• resume(): Promise<TaskResponse>

• Resumes a task that was previously on hold.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.resume();
  Copy

resumeRecording

• resumeRecording(resumeRecordingPayload): Promise<TaskResponse>

• Resumes a previously paused recording.

  Parameters

  • resumeRecordingPayload: ResumeRecordingPayload

    Parameters for resuming the recording

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.resumeRecording({
    autoResumed: false
  });
  Copy

toggleMute

• toggleMute(): Promise<void>

• Toggles mute/unmute for the local audio stream during a WebRTC task.

  Returns Promise<void>

  Promise

  Example

  await task.toggleMute();
  Copy

transfer

• transfer(transferPayload): Promise<TaskResponse>

• Transfers the task to another agent or queue.

  Parameters

  • transferPayload: TransferPayLoad

    Transfer details including destination and type

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.transfer({ to: "queueId", destinationType: "queue" });
  Copy

transferConference

• transferConference(): Promise<TaskResponse>

• Transfers the conference to another participant.

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.transferConference();
  Copy

wrapup

• wrapup(wrapupPayload): Promise<TaskResponse>

• Initiates wrap-up process for the task with specified details.

  Parameters

  • wrapupPayload: WrapupPayLoad

    Wrap-up details including reason and auxiliary code

  Returns Promise<TaskResponse>

  Promise

  Example

  await task.wrapup({
    wrapUpReason: "Customer issue resolved",
    auxCodeId: "RESOLVED"
  });
  Copy