Query parameters

• UiVersion string

  The Pinned UI version of the Configuration resource to fetch.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • account_sid string | null

    The SID of the Account that created the Configuration resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • date_created string(date-time) | null

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

  • date_updated string(date-time) | null

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

  • attributes

    An object that contains application-specific data.

  • status string

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

    Values are ok, inprogress, or notstarted.

  • taskrouter_workspace_sid string | null

    The SID of the TaskRouter Workspace.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WS[0-9a-fA-F]{32}$.

  • taskrouter_target_workflow_sid string | null

    The SID of the TaskRouter target Workflow.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WW[0-9a-fA-F]{32}$.

  • taskrouter_target_taskqueue_sid string | null

    The SID of the TaskRouter Target TaskQueue.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WQ[0-9a-fA-F]{32}$.

  • taskrouter_taskqueues array | null

    The list of TaskRouter TaskQueues.

  • taskrouter_skills array | null

    The Skill description for TaskRouter workers.

  • taskrouter_worker_channels

    The TaskRouter default channel capacities and availability for workers.

  • taskrouter_worker_attributes

    The TaskRouter Worker attributes.

  • taskrouter_offline_activity_sid string | null

    The TaskRouter SID of the offline activity.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^WA[0-9a-fA-F]{32}$.

  • runtime_domain string | null

    The URL where the Flex instance is hosted.

  • messaging_service_instance_sid string | null

    The SID of the Messaging service instance.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

  • chat_service_instance_sid string | null

    The SID of the chat service this user belongs to.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

  • flex_service_instance_sid string | null

    The SID of the Flex service instance.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

  • flex_instance_sid string | null

    The SID of the Flex instance.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^GO[0-9a-fA-F]{32}$.

  • ui_language string | null

    The primary language of the Flex UI.

  • ui_attributes

    The object that describes Flex UI characteristics and settings.

  • ui_dependencies

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

  • ui_version string | null

    The Pinned UI version.

  • service_version string | null

    The Flex Service version.

  • call_recording_enabled boolean | null

    Whether call recording is enabled.

  • call_recording_webhook_url string | null

    The call recording webhook URL.

  • crm_enabled boolean | null

    Whether CRM is present for Flex.

  • crm_type string | null

    The CRM type.

  • crm_callback_url string | null

    The CRM Callback URL.

  • crm_fallback_url string | null

    The CRM Fallback URL.

  • crm_attributes

    An object that contains the CRM attributes.

  • public_attributes

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

  • plugin_service_enabled boolean | null

    Whether the plugin service enabled.

  • plugin_service_attributes

    The plugin service attributes.

  • integrations array | null

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

  • outbound_call_flows

    The list of outbound call flows.

  • serverless_service_sids array[string] | null

    The list of serverless service SIDs.

    Minimum length of each is 34, maximum length of each is 34. Format of each should match the following pattern: ^ZS[0-9a-fA-F]{32}$.

  • queue_stats_configuration

    Configurable parameters for Queues Statistics.

  • notifications

    Configurable parameters for Notifications.

  • markdown

    Configurable parameters for Markdown.

  • url string(uri) | null

    The absolute URL of the Configuration resource.

  • flex_insights_hr

    Object with enabled/disabled flag with list of workspaces.

  • flex_insights_drilldown boolean | null

    Setting this to true will redirect Flex UI to the URL set in flex_url

  • flex_url string | null

    URL to redirect to in case drilldown is enabled.

  • channel_configs array | null

    Settings for different limits for Flex Conversations channels attachments.

  • debugger_integration

    Configurable parameters for Debugger Integration.

  • flex_ui_status_report

    Configurable parameters for Flex UI Status report.

  • agent_conv_end_methods

    Agent conversation end methods.

  • citrix_voice_vdi

    Citrix voice vdi configuration and settings.

  • offline_config

    Presence and presence ttl configuration