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

    Interface AccountConfigData<TUI>

    Account Configuration Data Response

    interface AccountConfigData<TUI = any> {
        accountSid: string;
        attributes: object;
        callRecordingEnabled: boolean;
        callRecordingWebhookUrl: string | null;
        channelConfigs: ChannelConfig[] | null;
        chatServiceInstanceSid: string;
        citrixVoiceVdi: CitrixVoiceVdi | null;
        crmAttributes: object | null;
        crmCallbackUrl: string | null;
        crmEnabled: boolean | null;
        crmFallbackUrl: string | null;
        crmType: string | null;
        dateCreated: Date;
        dateUpdated: Date;
        debuggerIntegration: DebuggerIntegration | null;
        flexInstanceSid: string | null;
        flexServiceInstanceSid: string | null;
        flexUiStatusReport: FlexUiStatusReport | null;
        integrations?: IntegrationsConfig[] | null;
        messagingServiceInstanceSid: string | null;
        outboundCallFlows: { [key: string]: OutboundFlows } | null;
        pluginServiceAttributes: object | null;
        pluginServiceEnabled: boolean | null;
        publicAttributes: object;
        queueStatsConfiguration: QueueStatsConfiguration | null;
        runtimeDomain: string;
        serverlessServiceSids: string[] | null;
        serviceVersion: string | null;
        status: string;
        taskrouterOfflineActivitySid?: string;
        taskrouterSkills?: SkillDefinition[];
        taskrouterTargetTaskqueueSid: string;
        taskrouterTargetWorkflowSid: string;
        taskrouterTaskqueues: TaskQueue[] | null;
        taskrouterWorkerAttributes: { [key: string]: object } | null;
        taskrouterWorkerChannels: { [key: string]: WorkerChannel } | null;
        taskrouterWorkspaceSid: string;
        uiAttributes: TUI;
        uiDependencies: { [key: string]: string } | null;
        uiLanguage: string | null;
        uiVersion: string;
        url: string;
    }

    Type Parameters

    • TUI = any
    Index

    Properties

    accountSid attributes callRecordingEnabled callRecordingWebhookUrl channelConfigs chatServiceInstanceSid citrixVoiceVdi crmAttributes crmCallbackUrl crmEnabled crmFallbackUrl crmType dateCreated dateUpdated debuggerIntegration flexInstanceSid flexServiceInstanceSid flexUiStatusReport integrations? messagingServiceInstanceSid outboundCallFlows pluginServiceAttributes pluginServiceEnabled publicAttributes queueStatsConfiguration runtimeDomain serverlessServiceSids serviceVersion status taskrouterOfflineActivitySid? taskrouterSkills? taskrouterTargetTaskqueueSid taskrouterTargetWorkflowSid taskrouterTaskqueues taskrouterWorkerAttributes taskrouterWorkerChannels taskrouterWorkspaceSid uiAttributes uiDependencies uiLanguage uiVersion url

    Properties

    accountSid: string

    The SID of the Account that created the resource

    attributes: object

    An object that contains application-specific data

    callRecordingEnabled: boolean

    Whether call recording is enabled

    callRecordingWebhookUrl: string | null

    The call recording webhook URL

    channelConfigs: ChannelConfig[] | null

    A list of objects that contain the configuration for different channels

    chatServiceInstanceSid: string

    The SID of the chat service this user belongs to

    citrixVoiceVdi: CitrixVoiceVdi | null
    crmAttributes: object | null

    An object that contains the CRM attributes

    crmCallbackUrl: string | null

    The CRM Callback URL

    crmEnabled: boolean | null

    Whether CRM is present for Flex

    crmFallbackUrl: string | null

    The CRM Fallback URL

    crmType: string | null

    The CRM type

    dateCreated: Date

    The ISO 8601 date and time in GMT when the Configuration resource was created

    dateUpdated: Date

    The ISO 8601 date and time in GMT when the Configuration resource was last updated

    debuggerIntegration: DebuggerIntegration | null
    flexInstanceSid: string | null

    The SID of the Flex instance

    flexServiceInstanceSid: string | null

    The SID of the Flex service instance

    flexUiStatusReport: FlexUiStatusReport | null
    integrations?: IntegrationsConfig[] | null

    A list of objects that contain the configurations for the Integrations supported in this configuration

    messagingServiceInstanceSid: string | null

    The SID of the Messaging service instance

    outboundCallFlows: { [key: string]: OutboundFlows } | null

    The list of outbound call flows

    pluginServiceAttributes: object | null

    The plugin service attributes

    pluginServiceEnabled: boolean | null

    If flex-ui should load plugins

    publicAttributes: object

    The list of public attributes, which are visible to unauthenticated clients

    queueStatsConfiguration: QueueStatsConfiguration | null
    runtimeDomain: string

    The URL where the Flex instance is hosted

    serverlessServiceSids: string[] | null

    The list of serverless service SIDs

    serviceVersion: string | null

    The Flex Service version

    status: string

    The status of the Flex onboarding. Can be: 'ok', 'inprogress','notstarted'

    taskrouterOfflineActivitySid?: string

    The TaskRouter SID of the offline activity

    taskrouterSkills?: SkillDefinition[]

    The Skill description for TaskRouter workers

    taskrouterTargetTaskqueueSid: string

    The SID of the TaskRouter Target TaskQueue

    taskrouterTargetWorkflowSid: string

    The SID of the TaskRouter target Workflow

    taskrouterTaskqueues: TaskQueue[] | null

    The list of TaskRouter TaskQueues

    taskrouterWorkerAttributes: { [key: string]: object } | null

    The TaskRouter Worker attributes

    taskrouterWorkerChannels: { [key: string]: WorkerChannel } | null

    The TaskRouter default channel capacities and availability for workers

    taskrouterWorkspaceSid: string

    The SID of the TaskRouter Workspace

    uiAttributes: TUI

    The object that describes Flex UI characteristics and settings

    uiDependencies: { [key: string]: string } | null

    The object that defines the NPM packages and versions to be used in Hosted Flex

    uiLanguage: string | null

    The primary language of the Flex UI

    uiVersion: string

    The Pinned UI version

    url: string

    The absolute URL of the Configuration resource

    Settings

    Member Visibility

    On This Page

    Properties