Class: ConfigurationInstance

Twilio.FlexApi.V1.ConfigurationInstance(version, payload)

new ConfigurationInstance(version, payload)

Initialize the ConfigurationContext
Parameters:
Name Type Description
version V1 Version of the resource
payload ConfigurationPayload The instance payload
Properties:
Name Type Description
accountSid string The SID of the Account that created the resource
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
attributes object An object that contains application-specific data
status configuration.status The status of the Flex onboarding
taskrouterWorkspaceSid string The SID of the TaskRouter Workspace
taskrouterTargetWorkflowSid string The SID of the TaskRouter target Workflow
taskrouterTargetTaskqueueSid string The SID of the TaskRouter Target TaskQueue
taskrouterTaskqueues object The list of TaskRouter TaskQueues
taskrouterSkills object The Skill description for TaskRouter workers
taskrouterWorkerChannels object The TaskRouter default channel capacities and availability for workers
taskrouterWorkerAttributes object The TaskRouter Worker attributes
taskrouterOfflineActivitySid string The TaskRouter SID of the offline activity
runtimeDomain string The URL where the Flex instance is hosted
messagingServiceInstanceSid string The SID of the Messaging service instance
chatServiceInstanceSid string The SID of the chat service this user belongs to
flexServiceInstanceSid string The SID of the Flex service instance
uiLanguage string The primary language of the Flex UI
uiAttributes object The object that describes Flex UI characteristics and settings
uiDependencies object The object that defines the NPM packages and versions to be used in Hosted Flex
uiVersion string The Pinned UI version
serviceVersion string The Flex Service version
callRecordingEnabled boolean Whether call recording is enabled
callRecordingWebhookUrl string The call recording webhook URL
crmEnabled boolean Whether CRM is present for Flex
crmType string The CRM Type
crmCallbackUrl string The CRM Callback URL
crmFallbackUrl string The CRM Fallback URL
crmAttributes object An object that contains the CRM attributes
publicAttributes object The list of public attributes
pluginServiceEnabled boolean Whether the plugin service enabled
pluginServiceAttributes object The plugin service attributes
integrations object A list of objects that contain the configurations for the Integrations supported in this configuration
outboundCallFlows object The list of outbound call flows
serverlessServiceSids string The list of serverless service SIDs
queueStatsConfiguration object Configurable parameters for Queues Statistics
notifications object Configurable parameters for Notifications
markdown object Configurable parameters for Markdown
url string The absolute URL of the Configuration resource
Source:

Methods

create(callbackopt) → {Promise}

create a ConfigurationInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ConfigurationInstance
Type
Promise

fetch(optsopt, callbackopt) → {Promise}

fetch a ConfigurationInstance
Parameters:
Name Type Attributes Description
opts object <optional>
 Options for request
Properties
Name Type Attributes Description
uiVersion string <optional>
 The Pinned UI version of the Configuration resource to fetch
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ConfigurationInstance
Type
Promise

toJSON()

Provide a user-friendly representation
Source:
Returns:
Object

update(callbackopt) → {Promise}

update a ConfigurationInstance
Parameters:
Name Type Attributes Description
callback function <optional>
 Callback to handle processed record
Source:
Returns:
Resolves to processed ConfigurationInstance
Type
Promise