Type alias AgentContact

AgentContact: Msg<{
    agentId: string;
    autoResumed?: boolean;
    childInteractionId?: string;
    consultMediaResourceId: string;
    consultingAgentId?: string;
    destAgentId: string;
    destinationType?: string;
    eventTime?: number;
    eventType: string;
    fromOwner?: boolean;
    id?: string;
    interaction: Interaction;
    interactionId: string;
    isConferencing: boolean;
    isConsulted?: boolean;
    isWebCallMute?: boolean;
    mediaResourceId: string;
    monitorType?: string;
    monitoringState?: {
        type: string;
    };
    orgId: string;
    owner: string;
    participantId?: string;
    queueMgr: string;
    queueName?: string;
    reason?: string;
    reasonCode?: string | number;
    reservationInteractionId?: string;
    reservedAgentChannelId?: string;
    ronaTimeout?: number;
    supervisorDN?: string;
    supervisorId?: string;
    supervisorName?: string;
    task?: Interaction;
    taskId?: string;
    toOwner?: boolean;
    trackingId: string;
    type: string;
    updatedBy?: string;
}>

Type representing an agent contact message within the contact center system Contains comprehensive interaction and task related details for agent operations

Type declaration

  • agentId: string

    Unique identifier of the agent handling the contact

  • Optional autoResumed?: boolean

    Indicates if the interaction was automatically resumed

  • Optional childInteractionId?: string

    Identifier for child interaction in case of consult/transfer

  • consultMediaResourceId: string

    Media resource identifier for consult operations

  • 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

    Type of the event (e.g., 'AgentDesktopMessage')

  • Optional fromOwner?: boolean

    Indicates if the message is from the owner of the interaction

  • Optional id?: string

    Unique identifier for monitoring offered events

  • interaction: Interaction

    Detailed interaction information including media and participant data

  • interactionId: string

    Unique identifier for the interaction

  • isConferencing: boolean

    Indicates if the interaction is in conference state

  • Optional isConsulted?: boolean

    Indicates if the interaction is in consult state

  • Optional isWebCallMute?: boolean

    Indicates if the web call is muted

  • mediaResourceId: string

    Unique identifier for the media resource

  • Optional monitorType?: string

    Type of monitoring (e.g., 'SILENT', 'BARGE_IN')

  • Optional monitoringState?: {
        type: string;
    }

    Current monitoring state information

    • type: string

      Type of monitoring state

  • orgId: string

    Organization identifier

  • owner: string

    Current owner of the interaction

  • Optional participantId?: string

    Unique identifier for the participant

  • queueMgr: string

    Queue manager handling the interaction

  • Optional queueName?: string

    Name of the queue where interaction 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

  • Optional ronaTimeout?: number

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

  • Optional supervisorDN?: string

    Dial number of the supervisor

  • Optional supervisorId?: string

    Identifier of the supervisor monitoring the interaction

  • Optional supervisorName?: string

    Name of the supervisor monitoring the interaction

  • Optional task?: Interaction

    Task details including media and state information

  • Optional taskId?: string

    Unique identifier for the task

  • Optional toOwner?: boolean

    Indicates if the message is to the owner of the interaction

  • trackingId: string

    Unique tracking identifier for the contact

  • type: string

    Type of the contact/interaction

  • Optional updatedBy?: string

    Identifier of the agent who last updated the interaction