— twilio-flex · SKMTC Hub

FlexV1Assessments3

FlexV1Channel4

FlexV1Configuration2

FlexV1ConfiguredPlugin2

FlexV1FlexFlow5

FlexV1InsightsAssessmentsComment2

FlexV1InsightsConversations1

FlexV1InsightsQuestionnaires5

FlexV1InsightsQuestionnairesCategory4

FlexV1InsightsQuestionnairesQuestion4

FlexV1InsightsSegments1

FlexV1InsightsSession1

FlexV1InsightsSettingsAnswerSets1

FlexV1InsightsSettingsComment1

FlexV1InsightsUserRoles1

FlexV1Interaction3

FlexV1InteractionChannel3

FlexV1InteractionChannelInvite2

FlexV1InteractionChannelParticipant3

FlexV1InteractionTransfer3

FlexV1Plugin4

FlexV1PluginArchive1

FlexV1PluginConfiguration3

FlexV1PluginConfigurationArchive1

FlexV1PluginRelease3

FlexV1PluginVersionArchive1

FlexV1PluginVersions3

FlexV1ProvisioningStatus1

FlexV1WebChannel5

FlexV1Configuration

get/v1/Configuration

Query parameters

UiVersionstring

The Pinned UI version of the Configuration resource to fetch.

Response

account_sidstring nullable

The SID of the Account that created the Configuration resource.

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

{"stackTrail":"components:schemas:flex.v1.configuration:properties:attributes","oasType":"schema","type":"unknown","description":"An object that contains application-specific data.","nullable":true}

status'ok' | 'inprogress' | 'notstarted'

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

taskrouter_workspace_sidstring nullable

The SID of the TaskRouter Workspace.

taskrouter_target_workflow_sidstring nullable

The SID of the TaskRouter target Workflow.

taskrouter_target_taskqueue_sidstring nullable

The SID of the TaskRouter Target TaskQueue.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:taskrouter_worker_channels","oasType":"schema","type":"unknown","description":"The TaskRouter default channel capacities and availability for workers.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:taskrouter_worker_attributes","oasType":"schema","type":"unknown","description":"The TaskRouter Worker attributes.","nullable":true}

taskrouter_offline_activity_sidstring nullable

The TaskRouter SID of the offline activity.

runtime_domainstring nullable

The URL where the Flex instance is hosted.

messaging_service_instance_sidstring nullable

The SID of the Messaging service instance.

chat_service_instance_sidstring nullable

The SID of the chat service this user belongs to.

flex_service_instance_sidstring nullable

The SID of the Flex service instance.

flex_instance_sidstring nullable

The SID of the Flex instance.

ui_languagestring nullable

The primary language of the Flex UI.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:ui_attributes","oasType":"schema","type":"unknown","description":"The object that describes Flex UI characteristics and settings.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:ui_dependencies","oasType":"schema","type":"unknown","description":"The object that defines the NPM packages and versions to be used in Hosted Flex.","nullable":true}

ui_versionstring nullable

The Pinned UI version.

service_versionstring nullable

The Flex Service version.

call_recording_enabledboolean nullable

Whether call recording is enabled.

call_recording_webhook_urlstring nullable

The call recording webhook URL.

crm_enabledboolean nullable

Whether CRM is present for Flex.

crm_typestring nullable

The CRM type.

crm_callback_urlstring nullable

The CRM Callback URL.

crm_fallback_urlstring nullable

The CRM Fallback URL.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:crm_attributes","oasType":"schema","type":"unknown","description":"An object that contains the CRM attributes.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:public_attributes","oasType":"schema","type":"unknown","description":"The list of public attributes, which are visible to unauthenticated clients.","nullable":true}

plugin_service_enabledboolean nullable

Whether the plugin service enabled.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:plugin_service_attributes","oasType":"schema","type":"unknown","description":"The plugin service attributes.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:outbound_call_flows","oasType":"schema","type":"unknown","description":"The list of outbound call flows.","nullable":true}

serverless_service_sidsstring[] nullable

The list of serverless service SIDs.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:queue_stats_configuration","oasType":"schema","type":"unknown","description":"Configurable parameters for Queues Statistics.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:notifications","oasType":"schema","type":"unknown","description":"Configurable parameters for Notifications.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:markdown","oasType":"schema","type":"unknown","description":"Configurable parameters for Markdown.","nullable":true}

urlstring uri nullable

The absolute URL of the Configuration resource.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:flex_insights_hr","oasType":"schema","type":"unknown","description":"Object with enabled/disabled flag with list of workspaces.","nullable":true}

flex_insights_drilldownboolean nullable

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

flex_urlstring nullable

URL to redirect to in case drilldown is enabled.

{"stackTrail":"components:schemas:flex.v1.configuration:properties:debugger_integration","oasType":"schema","type":"unknown","description":"Configurable parameters for Debugger Integration.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:flex_ui_status_report","oasType":"schema","type":"unknown","description":"Configurable parameters for Flex UI Status report.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:agent_conv_end_methods","oasType":"schema","type":"unknown","description":"Agent conversation end methods.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:citrix_voice_vdi","oasType":"schema","type":"unknown","description":"Citrix voice vdi configuration and settings.","nullable":true}

{"stackTrail":"components:schemas:flex.v1.configuration:properties:offline_config","oasType":"schema","type":"unknown","description":"Presence and presence ttl configuration","nullable":true}

Changes

Changed in 9 of the 51 revisions of this API.4916

Jul 3, 2025v10e4cd336d78a22See the full diff
- ▲
  the agent_conv_end_methods response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the channel_configs/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the citrix_voice_vdi response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the crm_attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the debugger_integration response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the flex_insights_hr response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the flex_ui_status_report response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the integrations/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the markdown response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the notifications response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the offline_config response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the outbound_call_flows response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the plugin_service_attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the public_attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the queue_stats_configuration response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the taskrouter_skills/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the taskrouter_taskqueues/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the taskrouter_worker_attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the taskrouter_worker_channels response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the ui_attributes response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  the ui_dependencies response's property type/format changed from object/ to / for status 200
  response-property-type-changed
Mar 11, 2025v165f781b3f6b122See the full diff
- ▲
  the agent_conv_end_methods response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the channel_configs/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the citrix_voice_vdi response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the crm_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the debugger_integration response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the flex_insights_hr response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the flex_ui_status_report response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the integrations/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the markdown response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the notifications response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the offline_config response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the outbound_call_flows response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the plugin_service_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the public_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the queue_stats_configuration response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the taskrouter_skills/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the taskrouter_taskqueues/items/ response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the taskrouter_worker_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the taskrouter_worker_channels response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the ui_attributes response's property type/format changed from / to object/ for status 200
  response-property-type-changed
- ▲
  the ui_dependencies response's property type/format changed from / to object/ for status 200
  response-property-type-changed
May 24, 2024v17e7d5d33e5825See the full diff
- ▲
  the call_recording_webhook_url response's property type/format changed from string/uri to string/ for status 200
  response-property-type-changed
- ▲
  the crm_callback_url response's property type/format changed from string/uri to string/ for status 200
  response-property-type-changed
- ▲
  the crm_fallback_url response's property type/format changed from string/uri to string/ for status 200
  response-property-type-changed
- ▲
  the flex_url response's property type/format changed from string/uri to string/ for status 200
  response-property-type-changed
- ▲
  the runtime_domain response's property type/format changed from string/uri to string/ for status 200
  response-property-type-changed
Feb 9, 2024v1864463450a762See the full diff
- ○
  added the optional property flex_instance_sid to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property offline_config to the response with the 200 status
  response-optional-property-added
Jan 25, 2024v159a5c6c485b11See the full diff
- ●
  removed the optional property offline_config from the response with the 200 status
  response-optional-property-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 19, 2023v1e1fc1e58b0721See the full diff
- ○
  added the optional property offline_config to the response with the 200 status
  response-optional-property-added
Sep 21, 2023v172a2711458e11See the full diff
- ○
  added the optional property citrix_voice_vdi to the response with the 200 status
  response-optional-property-added
Sep 7, 2023v13a89b03ab4371See the full diff
- ○
  added the optional property agent_conv_end_methods to the response with the 200 status
  response-optional-property-added
Aug 10, 2023v1c37c20a0a1cb1See the full diff
- ○
  api tag FlexV1Configuration added
  api-tag-added

Full history