FlexV1Configuration
post/v1/Configuration
Request body
object required
Response
OK
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}