Interface ConnectToAgentItem<TUserDefinedType>

A "connect to agent" item returned in a message response from a back-end. This is used when the back-end indicates that a user's conversation should be escalated to a human agent.

interface ConnectToAgentItem<TUserDefinedType = Record<string, unknown>> {
    agent_available?: { message: string };
    agent_message_type?: AgentMessageType;
    agent_unavailable?: { message: string };
    message_options?: GenericItemMessageOptions;
    message_to_human_agent?: string;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    transfer_info?: ConnectToAgentItemTransferInfo;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_available? agent_message_type? agent_unavailable? message_options? message_to_human_agent? response_type streaming_metadata? transfer_info? user_defined?

Properties

Optionalagent_available

agent_available?: { message: string }

Contains the message to be rendered if there are agents available.

Optionalagent_message_type

agent_message_type?: AgentMessageType

For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.

Optionalagent_unavailable

agent_unavailable?: { message: string }

Contains the message to be rendered if there are no agents available.

Optionalmessage_options

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

Optionalmessage_to_human_agent

message_to_human_agent?: string

A message to be sent to the human agent who will be taking over the conversation.

response_type

response_type: MessageResponseTypes

The response type of this message item.

Optionalstreaming_metadata

streaming_metadata?: ItemStreamingMetadata

Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.

Optionaltransfer_info

transfer_info?: ConnectToAgentItemTransferInfo

When a conversation is escalated to an agent additional information is needed to fullfill the request. This additional information typically is added by the channel integration and cannot be deduced from the dialog itself.

Optionaluser_defined

user_defined?: TUserDefinedType

An optional buckets of additional user defined properties for this item.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR