RuntimeResponseGenericRuntimeResponseTypeConnectToAgent

public struct RuntimeResponseGenericRuntimeResponseTypeConnectToAgent : Codable, Equatable

RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.

Enums with an associated value of RuntimeResponseGenericRuntimeResponseTypeConnectToAgent: RuntimeResponseGeneric

  • The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.

    Declaration

    Swift

    public var responseType: String

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

    Declaration

    Swift

    public var messageToHumanAgent: String?

  • An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.

    Declaration

    Swift

    public var agentAvailable: AgentAvailabilityMessage?

  • An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.

    Declaration

    Swift

    public var agentUnavailable: AgentAvailabilityMessage?

  • Routing or other contextual information to be used by target service desk systems.

    Declaration

    Swift

    public var transferInfo: DialogNodeOutputConnectToAgentTransferInfo?

  • A label identifying the topic of the conversation, derived from the title property of the relevant node or the topic property of the dialog node response.

    Declaration

    Swift

    public var topic: String?

  • The unique ID of the dialog node that the topic property is taken from. The topic property is populated using the value of the dialog node’s title property.

    Declaration

    Swift

    public var dialogNode: String?

  • An array of objects specifying channels for which the response is intended. If channels is present, the response is intended for a built-in integration and should not be handled by an API client.

    Declaration

    Swift

    public var channels: [ResponseGenericChannel]?

  • Initialize a RuntimeResponseGenericRuntimeResponseTypeConnectToAgent with member variables.

    Declaration

    Swift

    public init(
    responseType: String,
    messageToHumanAgent: String? = nil,
    agentAvailable: AgentAvailabilityMessage? = nil,
    agentUnavailable: AgentAvailabilityMessage? = nil,
    transferInfo: DialogNodeOutputConnectToAgentTransferInfo? = nil,
    topic: String? = nil,
    dialogNode: String? = nil,
    channels: [ResponseGenericChannel]? = nil
)

    Parameters

    responseType

    The type of response returned by the dialog node. The specified response type must be supported by the client application or channel.
    messageToHumanAgent

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

    An optional message to be displayed to the user to indicate that the conversation will be transferred to the next available agent.
    agentUnavailable

    An optional message to be displayed to the user to indicate that no online agent is available to take over the conversation.
    transferInfo

    Routing or other contextual information to be used by target service desk systems.
    topic

    A label identifying the topic of the conversation, derived from the title property of the relevant node or the topic property of the dialog node response.
    dialogNode

    The unique ID of the dialog node that the topic property is taken from. The topic property is populated using the value of the dialog node’s title property.
    channels

    An array of objects specifying channels for which the response is intended. If channels is present, the response is intended for a built-in integration and should not be handled by an API client.

    Return Value

    An initialized RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.