Type alias TaskData

TaskData: {
    agentId: string;
    agentsPendingWrapUp?: string[];
    autoResumed?: boolean;
    childInteractionId?: string;
    conferenceParticipantsCount?: number;
    consultMediaResourceId: string;
    consultStatus?: string;
    consultingAgentId?: string;
    destAgentId: string;
    destinationType?: string;
    eventTime?: number;
    eventType: string;
    fromOwner?: boolean;
    id?: string;
    interaction: Interaction;
    interactionId: string;
    isAutoAnswering?: boolean;
    isConferenceInProgress?: boolean;
    isConferencing: boolean;
    isConsultInProgress?: boolean;
    isConsulted?: boolean;
    isCustomerInCall?: boolean;
    isIncomingTask?: boolean;
    isOnHold?: boolean;
    isSecondaryAgent?: boolean;
    isSecondaryEpDnAgent?: boolean;
    isWebCallMute?: boolean;
    mediaResourceId: string;
    mpcState?: string;
    orgId: string;
    owner: string;
    participantId?: string;
    queueMgr: string;
    queueName?: string;
    reason?: string;
    reasonCode?: string | number;
    reservationInteractionId?: string;
    reservedAgentChannelId?: string;
    ronaTimeout?: number;
    task?: Interaction;
    taskId?: string;
    toOwner?: boolean;
    trackingId: string;
    type: string;
    updatedBy?: string;
    wrapUpRequired?: boolean;
}

Task payload mirroring the Agent Contact event payload from Webex Contact Center (developer.webex.com). Arrives on AGENT_* websocket events and is the source of truth for UI/state machine updates.

Type declaration

  • agentId: string

    Identifier of the agent handling the task

  • Optional agentsPendingWrapUp?: string[]

    Indicates if wrap-up is required for this task

  • Optional autoResumed?: boolean

    Indicates if the task was automatically resumed

  • Optional childInteractionId?: string

    Identifier for child interaction in consult/transfer scenarios

  • Optional conferenceParticipantsCount?: number

    Count of conference participants (agents only) Used for determining if max participants reached

  • consultMediaResourceId: string

    Media resource identifier for consultation leg when present

  • Optional consultStatus?: string

    Current consultation status derived from state machine Values: CONSULT_INITIATED, CONSULT_ACCEPTED, BEING_CONSULTED, BEING_CONSULTED_ACCEPTED, CONNECTED, CONFERENCE, CONSULT_COMPLETED

  • Optional consultingAgentId?: string

    Identifier of the consulting agent

  • destAgentId: string

    Identifier of the destination agent for transfers/consults

  • Optional destinationType?: string

    Type of destination for transfer/consult

  • Optional eventTime?: number

    Timestamp when the event occurred

  • eventType: string

    Agent event name from the websocket stream (e.g., AGENT_CONTACT_ASSIGNED)

  • Optional fromOwner?: boolean

    Indicates if the task is from the owner

  • Optional id?: string

    Unique identifier for monitoring offered events

  • interaction: Interaction

    Detailed interaction information

  • interactionId: string

    Interaction/contact identifier from backend (same as interaction.interactionId)

  • Optional isAutoAnswering?: boolean

    Indicates if auto-answer is in progress for this task

  • Optional isConferenceInProgress?: boolean

    Indicates if a conference is currently in progress (2+ active agents)

  • isConferencing: boolean

    Indicates if the task is in conference state

  • Optional isConsultInProgress?: boolean

    Indicates if consultation is in progress (state machine: CONSULTING)

  • Optional isConsulted?: boolean

    Indicates if the task is in consultation state

  • Optional isCustomerInCall?: boolean

    Indicates if customer is currently in the call Derived from participants in main media

  • Optional isIncomingTask?: boolean

    Indicates if the task is incoming for the active agent

  • Optional isOnHold?: boolean

    Indicates if the task is on hold (state machine: HELD)

  • Optional isSecondaryAgent?: boolean

    Indicates if this is a secondary agent (consulted party)

  • Optional isSecondaryEpDnAgent?: boolean

    Indicates if this is a secondary EP-DN agent (telephony consult to external)

  • Optional isWebCallMute?: boolean

    Indicates if the web call is muted

  • mediaResourceId: string

    Primary media resource identifier for the active leg (matches interaction.media[].mediaResourceId)

  • Optional mpcState?: string

    Task state for MPC (Multi-Party Conference) scenarios Maps participant consultState to task state

  • orgId: string

    Organization identifier

  • owner: string

    Current owner of the task

  • Optional participantId?: string

    Unique identifier for the participant

  • queueMgr: string

    Queue manager handling the task

  • Optional queueName?: string

    Name of the queue where task is queued

  • Optional reason?: string

    Description of the reason for an action

  • Optional reasonCode?: string | number

    Code indicating the reason for an action

  • Optional reservationInteractionId?: string

    Identifier for reservation interaction

  • Optional reservedAgentChannelId?: string

    Identifier for the reserved agent channel (used for campaign tasks)

  • Optional ronaTimeout?: number

    Timeout value for RONA (Redirection on No Answer) in seconds

  • Optional task?: Interaction

    Task details including state and media information

  • Optional taskId?: string

    Unique identifier for the task

  • Optional toOwner?: boolean

    Indicates if the task is to the owner

  • trackingId: string

    Unique tracking identifier for the task

  • type: string

    Task/interaction type returned by the platform (routing/monitoring/etc.)

  • Optional updatedBy?: string

    Identifier of agent who last updated the task

  • Optional wrapUpRequired?: boolean

    Indicates if wrap-up is required for this task

Settings

Member Visibility

Theme