@twilio/flex-sdk
    Preparing search index...

    Module @twilio/flex-sdk

    To initialize the Flex SDK, simply call createClient with your SDK token:

    import { createClient } from "@twilio/flex-sdk";

    // Initialize the client
    const client = await createClient("SDK_TOKEN");

    Actions

    AcceptTask
    AddConversationEventListener
    AddEmailParticipant
    AddExternalVoiceParticipant
    AddTaskParticipantListener
    AddVoiceEventListener
    CancelVoiceTaskTransfer
    CompleteTask
    EndTask
    EndVoiceCallForAll
    GetCallByTask
    GetConversationByTask
    GetConversationsUser
    GetConversationTransfers
    GetPausedConversations
    GetTaskParticipants
    HoldVoiceParticipant
    InitializeDataClient
    KickVoiceParticipant
    LeaveConversation
    MonitorCall
    PauseConversation
    RejectTask
    RemoveEmailParticipant
    ResumeConversation
    SetAttributes
    SetCurrentActivity
    SetTaskAttributes
    SetWorkerActivity
    SetWorkerAttributes
    StartConversationTransfer
    StartOutboundCall
    StartOutboundEmailTask
    StartVoiceTaskTransfer
    UnholdVoiceParticipant
    WrapUpTask

    Authentication

    exchangeToken
    getAuthenticationConfig
    getLoginDetails
    refreshToken
    validateToken

    Other

    ClientEvent
    ConversationClientEvent
    ErrorCode
    ErrorSeverity
    MediaChannelType
    MessagesDirection
    ParticipantCallStatus
    ParticipantLevel
    ParticipantType
    ReasonParticipantLeft
    StatusCallbackEvent
    VoiceClientEvent
    Channel
    ConversationParticipant
    ConversationsClient
    ConversationsUser
    FlexSdkError
    Media
    Message
    MessageBuilder
    Reservation
    RoutingProperties
    Supervisor
    Task
    TwilioConversation
    Worker
    Workspace
    AcceptTaskOptions
    AccountConfigData
    AccountConfigOptions
    AccountSidOption
    Action
    Activity
    ActivityOptions
    AddConversationEventListenerResponse
    AddEmailParticipantOptions
    AddExternalVoiceParticipantOptions
    AddTaskParticipantListenerResponse
    AddVoiceEventListenerOptions
    AddVoiceEventListenerResponse
    AddVoiceListenerEvent
    AddVoiceParticipantResponse
    Attachments
    AuthenticationConfig
    AuthenticationConfigParams
    AuthenticationConfigResponse
    BaseParticipant
    CallOptions
    ChannelConfig
    ChannelEvents
    CitrixVoiceVdi
    Client
    ClientEventsType
    ClientOptions
    ConferenceOptions
    ConnectionError
    ConsoleExchangeTokenParams
    ConsoleLoginDetailsParams
    ConsoleSessionOptions
    Conversation
    ConversationClientEvents
    ConversationTransfer
    DataClientOptions
    DebuggerIntegration
    DefaultQueueStatsConfiguration
    DefaultSessionOptions
    DequeueOptions
    FeaturesConfig
    FeaturesList
    FlexSdkErrorMetadata
    FlexUiStatusReport
    GetCallByTaskOptions
    GetConversationTransfersOptions
    GetPausedConversationsOptions
    HoldCallOptions
    HoldVoiceParticipantOptions
    IncomingTransfer
    IntegrationsConfig
    LegacyTokenData
    LoggerOptions
    LoginDetailsResponse
    MonitorCallOptions
    OutboundFlows
    OutgoingTransfer
    Paginator
    PausedConversation
    PublicConfig
    PublicConfigAttributes
    QueueChannelConfiguration
    QueueConfiguration
    QueueStatsConfiguration
    RedirectOptions
    RefreshTokenParams
    RefreshTokenResponse
    RejectOptions
    RejectTaskOptions
    ReservationEvents
    ReservationParticipantOptions
    ResumeConversationResponse
    RuntimeDomainOption
    SendEmailMessageOptions
    SendMediaMessageOptions
    SendTextMessageOptions
    SetAttributesOptions
    SetCurrentActivityOptions
    SetTaskAttributesOptions
    SetWorkerActivityOptions
    SetWorkerAttributesOptions
    SkillDefinition
    SSOExchangeTokenParams
    SSOLoginDetailsParams
    SSOSessionOptions
    SSOTokenData
    StartConversationTransferOptions
    StartOutboundCallOptions
    StartOutboundEmailTaskOptions
    StartOutboundEmailTaskResponse
    TaskEvents
    TaskHoldOptions
    TaskOptions
    TaskParticipantEvent
    TaskParticipantOptions
    TaskQueue
    TaskReservation
    TaskRouterOptions
    TaskRouterTaskQueue
    TaskTransferOptions
    TelemetryOptions
    TokenRefreshResult
    TransferOptions
    Transfers
    TransferTaskOptions
    VoiceCall
    VoiceOptions
    WorkerChannel
    WorkerEvents
    WorkerOptions
    WorkspaceOptions
    WrappingOptions
    AddVoiceParticipantMediaProperties
    AddVoiceParticipantOptions
    AppType
    ConversationMediaProperties
    ConversationParticipantType
    ConversationParticipantUpdateReason
    ConversationStatus
    ConversationTaskParticipant
    ConversationUpdateReason
    DeepPartial
    DeliveryStatus
    ExchangeTokenParams
    FetchTaskQueuesParams
    FetchWorkersInfoParams
    FetchWorkersParams
    GetTaskParticipantsResponse
    GetToken
    LoggerLevel
    LoggerLevelNumbers
    LoginDetailsParams
    MediaCategory
    MediaProperties
    MessageType
    MessageUpdateReason
    NotificationLevel
    ParticipantCallProperties
    ParticipantCallRecordProperties
    ParticipantCallStatusProperties
    ParticipantEmailLevel
    ParticipantEventData
    ParticipantResponse
    ParticipantSipProperties
    PausedChannelsResponse
    RoutingData
    SessionOptions
    TaskParticipant
    TokenData
    Transfer
    TwilsockConnectionState
    TypePolicies
    UserUpdateReason
    VoiceMediaProperties
    VoiceTaskParticipant
    Without
    WorkerInfo
    XOR
    version
    createClient
    getAccountConfig
    getFeaturesConfig
    getPublicConfig
    setAccountConfig
    ExchangeTokenResponse → RefreshTokenResponse