Fetch configuration

GET /v1/Configuration

Configuration for a Flex instance

Query parameters

UiVersion string

The Pinned UI version of the Configuration resource to fetch.

Responses

• 200

OK
Hide response attributes Show response attributes object
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- attributes
  
  An object that contains application-specific data
- call_recording_enabled boolean | null
  
  Whether call recording is enabled
- call_recording_webhook_url string(uri) | null
  
  The call recording webhook URL
- channel_configs array | null
  
  Flex Conversations channels' attachments configurations
- 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}$.
- crm_attributes
  
  An object that contains the CRM attributes
- crm_callback_url string(uri) | null
  
  The CRM Callback URL
- crm_enabled boolean | null
  
  Whether CRM is present for Flex
- crm_fallback_url string(uri) | null
  
  The CRM Fallback URL
- crm_type string | null
  
  The CRM Type
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Configuration resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the Configuration resource was last updated
- flex_insights_drilldown boolean | null
  
  Setting to enable Flex UI redirection
- flex_insights_hr
  
  Object that controls workspace reporting
- 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_url string(uri) | null
  
  URL to redirect to in case drilldown is enabled.
- integrations array | null
  
  A list of objects that contain the configurations for the Integrations supported in this configuration
- markdown
  
  Configurable parameters for Markdown
- 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}$.
- notifications
  
  Configurable parameters for Notifications
- outbound_call_flows
  
  The list of outbound call flows
- plugin_service_attributes
  
  The plugin service attributes
- plugin_service_enabled boolean | null
  
  Whether the plugin service enabled
- public_attributes
  
  The list of public attributes
- queue_stats_configuration
  
  Configurable parameters for Queues Statistics
- runtime_domain string(uri) | null
  
  The URL where the Flex instance is hosted
- 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}$.
- service_version string | null
  
  The Flex Service version
- status string | null
  
  The status of the Flex onboarding
  
  Values are ok, inprogress, or notstarted.
- 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}$.
- taskrouter_skills array | null
  
  The Skill description for TaskRouter workers
- 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_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_taskqueues array | null
  
  The list of TaskRouter TaskQueues
- taskrouter_worker_attributes
  
  The TaskRouter Worker attributes
- taskrouter_worker_channels
  
  The TaskRouter default channel capacities and availability for workers
- 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}$.
- 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_language string | null
  
  The primary language of the Flex UI
- ui_version string | null
  
  The Pinned UI version
- url string(uri) | null
  
  The absolute URL of the Configuration resource

GET /v1/Configuration

curl \
 -X GET https://flex-api.twilio.com/v1/Configuration \
 --user "username:password"

Response examples (200)

{
  "account_sid": "string",
  "call_recording_enabled": true,
  "call_recording_webhook_url": "https://example.com",
  "channel_configs": [],
  "chat_service_instance_sid": "string",
  "crm_callback_url": "https://example.com",
  "crm_enabled": true,
  "crm_fallback_url": "https://example.com",
  "crm_type": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "flex_insights_drilldown": true,
  "flex_service_instance_sid": "string",
  "flex_url": "https://example.com",
  "integrations": [],
  "messaging_service_instance_sid": "string",
  "plugin_service_enabled": true,
  "runtime_domain": "https://example.com",
  "serverless_service_sids": [
    "string"
  ],
  "service_version": "string",
  "status": "ok",
  "taskrouter_offline_activity_sid": "string",
  "taskrouter_skills": [],
  "taskrouter_target_taskqueue_sid": "string",
  "taskrouter_target_workflow_sid": "string",
  "taskrouter_taskqueues": [],
  "taskrouter_workspace_sid": "string",
  "ui_language": "string",
  "ui_version": "string",
  "url": "https://example.com"
}