components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: ai_insights_enum_tag_group: type: string enum: - topics flex.v1.channel: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Channel resource and owns this Workflow. flex_flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Flow. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Channel resource. user_sid: type: string minLength: 34 maxLength: 34 pattern: ^US[0-9a-fA-F]{32}$ nullable: true description: The SID of the chat user. task_sid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ nullable: true description: The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external` url: type: string format: uri nullable: true description: The absolute URL of the Flex chat channel resource. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex chat channel was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Flex chat channel was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. flex.v1.configuration: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Configuration resource. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Configuration resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Configuration resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. attributes: nullable: true description: An object that contains application-specific data. status: $ref: '#/components/schemas/configuration_enum_status' taskrouter_workspace_sid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ nullable: true description: The SID of the TaskRouter Workspace. taskrouter_target_workflow_sid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ nullable: true description: The SID of the TaskRouter target Workflow. taskrouter_target_taskqueue_sid: type: string minLength: 34 maxLength: 34 pattern: ^WQ[0-9a-fA-F]{32}$ nullable: true description: The SID of the TaskRouter Target TaskQueue. taskrouter_taskqueues: type: array items: {} nullable: true description: The list of TaskRouter TaskQueues. taskrouter_skills: type: array items: {} nullable: true description: The Skill description for TaskRouter workers. taskrouter_worker_channels: nullable: true description: The TaskRouter default channel capacities and availability for workers. taskrouter_worker_attributes: nullable: true description: The TaskRouter Worker attributes. taskrouter_offline_activity_sid: type: string minLength: 34 maxLength: 34 pattern: ^WA[0-9a-fA-F]{32}$ nullable: true description: The TaskRouter SID of the offline activity. runtime_domain: type: string nullable: true description: The URL where the Flex instance is hosted. messaging_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the Messaging service instance. chat_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the chat service this user belongs to. flex_service_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex service instance. flex_instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^GO[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex instance. ui_language: type: string nullable: true description: The primary language of the Flex UI. ui_attributes: nullable: true description: The object that describes Flex UI characteristics and settings. ui_dependencies: nullable: true description: The object that defines the NPM packages and versions to be used in Hosted Flex. ui_version: type: string nullable: true description: The Pinned UI version. service_version: type: string nullable: true description: The Flex Service version. call_recording_enabled: type: boolean nullable: true description: Whether call recording is enabled. call_recording_webhook_url: type: string nullable: true description: The call recording webhook URL. crm_enabled: type: boolean nullable: true description: Whether CRM is present for Flex. crm_type: type: string nullable: true description: The CRM type. crm_callback_url: type: string nullable: true description: The CRM Callback URL. crm_fallback_url: type: string nullable: true description: The CRM Fallback URL. crm_attributes: nullable: true description: An object that contains the CRM attributes. public_attributes: nullable: true description: The list of public attributes, which are visible to unauthenticated clients. plugin_service_enabled: type: boolean nullable: true description: Whether the plugin service enabled. plugin_service_attributes: nullable: true description: The plugin service attributes. integrations: type: array items: {} nullable: true description: A list of objects that contain the configurations for the Integrations supported in this configuration. outbound_call_flows: nullable: true description: The list of outbound call flows. serverless_service_sids: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^ZS[0-9a-fA-F]{32}$ nullable: true description: The list of serverless service SIDs. queue_stats_configuration: nullable: true description: Configurable parameters for Queues Statistics. notifications: nullable: true description: Configurable parameters for Notifications. markdown: nullable: true description: Configurable parameters for Markdown. url: type: string format: uri nullable: true description: The absolute URL of the Configuration resource. flex_insights_hr: nullable: true description: Object with enabled/disabled flag with list of workspaces. flex_insights_drilldown: type: boolean nullable: true description: Setting this to true will redirect Flex UI to the URL set in flex_url flex_url: type: string nullable: true description: URL to redirect to in case drilldown is enabled. channel_configs: type: array items: {} nullable: true description: Settings for different limits for Flex Conversations channels attachments. debugger_integration: nullable: true description: Configurable parameters for Debugger Integration. flex_ui_status_report: nullable: true description: Configurable parameters for Flex UI Status report. agent_conv_end_methods: nullable: true description: Agent conversation end methods. citrix_voice_vdi: nullable: true description: Citrix voice vdi configuration and settings. offline_config: nullable: true description: Presence and presence ttl configuration configuration_enum_status: type: string enum: - ok - inprogress - notstarted description: 'The status of the Flex onboarding. Can be: `ok`, `inprogress`,`notstarted`.' flex.v1.plugin_configuration.configured_plugin: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for. configuration_sid: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Plugin Configuration that this Flex Plugin belongs to. plugin_sid: type: string minLength: 34 maxLength: 34 pattern: ^FP[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Plugin. plugin_version_sid: type: string minLength: 34 maxLength: 34 pattern: ^FV[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Plugin Version. phase: type: integer default: 0 description: The phase this Flex Plugin would initialize at runtime. plugin_url: type: string nullable: true description: The URL of where the Flex Plugin Version JavaScript bundle is hosted on. x-twilio: pii: handling: standard deleteSla: 30 unique_name: type: string nullable: true description: The name that uniquely identifies this Flex Plugin resource. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The friendly name of this Flex Plugin resource. description: type: string nullable: true description: A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long plugin_archived: type: boolean nullable: true description: Whether the Flex Plugin is archived. The default value is false. version: type: string nullable: true description: The latest version of this Flex Plugin Version. changelog: type: string nullable: true description: A changelog that describes the changes this Flex Plugin Version brings. plugin_version_archived: type: boolean nullable: true description: Whether the Flex Plugin Version is archived. The default value is false. private: type: boolean nullable: true description: Whether to validate the request is authorized to access the Flex Plugin Version. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin was installed specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin resource. flex.v1.flex_flow: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Flow resource and owns this Workflow. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. sid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Flow resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. x-twilio: pii: handling: standard deleteSla: 30 chat_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ nullable: true description: The SID of the chat service. channel_type: $ref: '#/components/schemas/flex_flow_enum_channel_type' contact_identity: type: string nullable: true description: The channel contact's Identity. enabled: type: boolean nullable: true description: Whether the Flex Flow is enabled. integration_type: $ref: '#/components/schemas/flex_flow_enum_integration_type' integration: nullable: true description: An object that contains specific parameters for the integration. long_lived: type: boolean nullable: true description: When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`. janitor_enabled: type: boolean nullable: true description: When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`. url: type: string format: uri nullable: true description: The absolute URL of the Flex Flow resource. flex_flow_enum_channel_type: type: string enum: - web - sms - facebook - whatsapp - line - custom description: "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`,\ \ `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes\ \ it on to the Task attributes for Tasks created based on this Flex Flow.\ \ The Task attributes will be used by the Flex UI to render the respective\ \ Task as appropriate (applying channel-specific design and length limits).\ \ If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ \ should set the Task Channel to Programmable Chat." flex_flow_enum_integration_type: type: string enum: - studio - external - task description: 'The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`.' flex_meeting_callback_events_enum_webhook_method: type: string enum: - POST - GET description: The Webhook Method of Global Webhook Configuration. One of `POST` or `GET`. flex_meeting_callback_events_enum_webhook_type: type: string enum: - global - interaction flex.v1.flex_team: type: object properties: team_sid: type: string minLength: 34 maxLength: 34 pattern: ^QO[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true member_count: type: integer default: 0 description: type: string nullable: true level: type: integer default: 0 parent_team_sid: type: string minLength: 34 maxLength: 34 pattern: ^QO[0-9a-fA-F]{32}$ nullable: true date_created: type: string format: date-time nullable: true date_updated: type: string format: date-time nullable: true version: type: integer default: 0 account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^GO[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true flex.v1.flex_team_context: type: object properties: team_setup_complete: type: boolean nullable: true conversational_insights_enabled: type: boolean nullable: true historical_reporting_enabled: type: boolean nullable: true flex.v1.flex_team_members: type: object properties: flex_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^FU[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true email: type: string nullable: true worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true team_sid: type: string minLength: 34 maxLength: 34 pattern: ^QO[0-9a-fA-F]{32}$ nullable: true instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^GO[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true flex.v1.flex_team_owners: type: object properties: flex_user_sid: type: string minLength: 34 maxLength: 34 pattern: ^FU[0-9a-fA-F]{32}$ nullable: true friendly_name: type: string nullable: true email: type: string nullable: true worker_sid: type: string minLength: 34 maxLength: 34 pattern: ^WK[0-9a-fA-F]{32}$ nullable: true team_sid: type: string minLength: 34 maxLength: 34 pattern: ^QO[0-9a-fA-F]{32}$ nullable: true instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^GO[0-9a-fA-F]{32}$ nullable: true account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true url: type: string format: uri nullable: true flex.v1.insights_assessments: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The unique SID identifier of the Account. assessment_sid: type: string minLength: 34 maxLength: 34 pattern: ^FM[0-9a-fA-F]{32}$ nullable: true description: The SID of the assessment offset: type: number nullable: true description: Offset of the conversation report: type: boolean nullable: true description: 'The flag indicating if this assessment is part of report ' weight: type: number nullable: true description: The weightage given to this comment agent_id: type: string nullable: true description: The id of the Agent segment_id: type: string nullable: true description: Segment Id of conversation user_name: type: string nullable: true description: The name of the user. user_email: type: string nullable: true description: The email id of the user. answer_text: type: string nullable: true description: The answer text selected by user answer_id: type: string nullable: true description: The id of the answer selected by user assessment: nullable: true description: Assessment Details associated with an assessment timestamp: type: number nullable: true url: type: string format: uri nullable: true flex.v1.insights_assessments_comment: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. assessment_sid: type: string minLength: 34 maxLength: 34 pattern: ^FM[0-9a-fA-F]{32}$ nullable: true description: The SID of the assessment. comment: nullable: true description: The comment added for assessment. offset: type: number nullable: true description: The offset report: type: boolean nullable: true description: 'The flag indicating if this assessment is part of report ' weight: type: number nullable: true description: The weightage given to this comment agent_id: type: string nullable: true description: The id of the agent. segment_id: type: string nullable: true description: The id of the segment. user_name: type: string nullable: true description: The name of the user. user_email: type: string nullable: true description: The email id of the user. timestamp: type: number nullable: true description: The timestamp when the record is inserted url: type: string format: uri nullable: true insights_conversational_ai_enum_granularity: type: string enum: - days - weeks - months - quarters - years insights_conversational_ai_enum_name: type: string enum: - predictive_scores - channel_metrics - agent_metrics - queue_metrics - agents_csat_summary - topic_metrics - conversation_metrics - trend_metrics insights_conversational_ai_enum_type: type: string enum: - metrics - summary - trend insights_conversational_ai_enum_sort_direction: type: string enum: - asc - desc insights_conversational_ai_enum_sort_by: type: string enum: - record_count - scored_count - total - mean - scored_mean - score insights_conversational_ai_enum_score_id: type: string enum: - ~predicted-csat - ~agent-experience - ~customer-effort - ~multitouch-risk insights_conversational_ai_enum_tier: type: string enum: - Low - High - Neutral flex.v1.insights_conversations: type: object properties: account_id: type: string nullable: true description: The id of the account. conversation_id: type: string nullable: true description: The unique id of the conversation segment_count: type: integer default: 0 description: The count of segments for a conversation segments: type: array items: {} nullable: true description: The Segments of a conversation flex.v1.insights_questionnaires: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. questionnaire_sid: type: string minLength: 34 maxLength: 34 pattern: ^GM[0-9a-fA-F]{32}$ nullable: true description: The sid of this questionnaire name: type: string nullable: true description: The name of this category. description: type: string nullable: true description: The description of this questionnaire active: type: boolean nullable: true description: The flag to enable or disable questionnaire questions: type: array items: {} nullable: true description: The list of questions with category for a questionnaire url: type: string format: uri nullable: true flex.v1.insights_questionnaires_category: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. category_sid: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ nullable: true description: The SID of the category name: type: string nullable: true description: The name of this category. url: type: string format: uri nullable: true flex.v1.insights_questionnaires_question: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. question_sid: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ nullable: true description: The SID of the question question: type: string nullable: true description: The question. description: type: string nullable: true description: The description for the question. category: nullable: true description: The Category for the question. answer_set_id: type: string nullable: true description: The answer_set for the question. allow_na: type: boolean nullable: true description: The flag to enable for disable NA for answer. usage: type: integer default: 0 description: Integer value that tells a particular question is used by how many questionnaires answer_set: nullable: true description: Set of answers for the question url: type: string format: uri nullable: true flex.v1.insights_segments: type: object properties: segment_id: type: string nullable: true description: To unique id of the segment external_id: type: string nullable: true description: The unique id for the conversation. queue: type: string nullable: true external_contact: type: string nullable: true external_segment_link_id: type: string nullable: true description: The uuid for the external_segment_link. date: type: string nullable: true description: The date of the conversation. account_id: type: string nullable: true description: The unique id for the account. external_segment_link: type: string nullable: true description: The hyperlink to recording of the task event. agent_id: type: string nullable: true description: The unique id for the agent. agent_phone: type: string nullable: true description: The phone number of the agent. agent_name: type: string nullable: true description: The name of the agent. agent_team_name: type: string nullable: true description: The team name to which agent belongs. agent_team_name_in_hierarchy: type: string nullable: true description: he team name to which agent belongs. agent_link: type: string nullable: true description: The link to the agent conversation. customer_phone: type: string nullable: true description: The phone number of the customer. customer_name: type: string nullable: true description: The name of the customer. customer_link: type: string nullable: true description: The link to the customer conversation. segment_recording_offset: type: string nullable: true description: The offset value for the recording. media: nullable: true description: The media identifiers of the conversation. assessment_type: nullable: true description: The type of the assessment. assessment_percentage: nullable: true description: The percentage scored on the Assessments. url: type: string format: uri nullable: true flex.v1.insights_session: type: object properties: workspace_id: type: string nullable: true description: Unique ID to identify the user's workspace session_expiry: type: string nullable: true description: The session expiry date and time, given in ISO 8601 format. session_id: type: string nullable: true description: The unique ID for the session base_url: type: string nullable: true description: The base URL to fetch reports and dashboards url: type: string format: uri nullable: true description: The URL of this resource. flex.v1.insights_settings_answersets: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. answer_sets: nullable: true description: The lis of answer sets answer_set_categories: nullable: true description: The list of answer set categories not_applicable: nullable: true description: The details for not applicable answer set url: type: string format: uri nullable: true flex.v1.insights_settings_comment: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Insights resource and owns this resource. comments: nullable: true url: type: string format: uri nullable: true flex.v1.insights_user_roles: type: object properties: roles: type: array items: type: string nullable: true description: Flex Insights roles for the user url: type: string format: uri nullable: true flex.v1.interaction: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction resource, prefixed with KD. channel: nullable: true description: "A JSON object that defines the Interaction\u2019s communication\ \ channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ \ and [inbound (API-initiated)](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#api-initiated-contact)\ \ Channel object examples." routing: nullable: true description: "A JSON Object representing the routing rules for the Interaction\ \ Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ \ for an example Routing object. The Interactions resource uses TaskRouter\ \ for all routing functionality. \n All attributes in the Routing object\ \ on your Interaction request body are added \u201Cas is\u201D to the\ \ task. For a list of known attributes consumed by the Flex UI and/or\ \ Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true interaction_context_sid: type: string minLength: 34 maxLength: 34 pattern: ^HQ[0-9a-fA-F]{32}$ nullable: true webhook_ttid: type: string nullable: true flex.v1.interaction.interaction_channel: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction resource, prefixed with KD. type: $ref: '#/components/schemas/interaction_channel_enum_type' status: $ref: '#/components/schemas/interaction_channel_enum_channel_status' error_code: type: integer nullable: true description: The Twilio error code for a failed channel. error_message: type: string nullable: true description: The error message for a failed channel. url: type: string format: uri nullable: true links: type: object format: uri-map nullable: true interaction_channel_enum_status: type: string enum: - closed - wrapup description: The status of this channel. interaction_channel_enum_type: type: string enum: - voice - sms - email - web - whatsapp - chat - messenger - gbm description: "The Interaction Channel's type. Can be: `sms`, `email`, `chat`,\ \ `whatsapp`, `web`, `messenger`, or `gbm`. \n **Note:** These can be different\ \ from the task channel type specified in the Routing attributes. Task channel\ \ type corresponds to channel capacity while this channel type is the actual\ \ media type" interaction_channel_enum_channel_status: type: string enum: - setup - active - failed - closed - inactive description: The status of this channel. interaction_channel_enum_update_channel_status: type: string enum: - closed - inactive interaction_channel_app_enum_type: type: string enum: - transcription - studio interaction_channel_app_enum_status: type: string enum: - adding - active - pausing - paused - resuming - removing - removed - errored flex.v1.interaction.interaction_channel.interaction_channel_invite: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^KG[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction Channel Invite resource. interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true description: The Interaction SID for this Channel. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true description: The Channel SID for this Invite. routing: nullable: true description: "A JSON object representing the routing rules for the Interaction\ \ Channel. See [Outbound SMS Example](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\ \ for an example Routing object. The Interactions resource uses TaskRouter\ \ for all routing functionality. \n All attributes in the Routing object\ \ on your Interaction request body are added \u201Cas is\u201D to the\ \ task. For a list of known attributes consumed by the Flex UI and/or\ \ Flex Insights, see [Known Task Attributes](https://www.twilio.com/docs/flex/developer/conversations/interactions-api#task-attributes)." url: type: string format: uri nullable: true interaction_channel_invite_enum_action: type: string enum: - accept - decline interaction_channel_invite_enum_type: type: string enum: - taskrouter flex.v1.interaction.interaction_channel.interaction_channel_participant: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction Channel Participant resource. type: $ref: '#/components/schemas/interaction_channel_participant_enum_type' interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true description: The Interaction Sid for this channel. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true description: The Channel Sid for this Participant. url: type: string format: uri nullable: true routing_properties: nullable: true description: The Participant's routing properties. interaction_channel_participant_enum_status: type: string enum: - closed - wrapup interaction_channel_participant_enum_type: type: string enum: - supervisor - customer - external - agent - unknown description: 'Participant type. Can be: `agent`, `customer`, `supervisor`, `external`, `unknown`' flex.v1.interaction.interaction_channel.interaction_transfer: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^UX[0-9a-fA-F]{32}$ nullable: true description: The unique string created by Twilio to identify an Interaction Transfer resource. instance_sid: type: string minLength: 34 maxLength: 34 pattern: ^GO[0-9a-fA-F]{32}$ nullable: true description: The SID of the Instance associated with the Transfer. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the Account that created the Transfer. interaction_sid: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ nullable: true description: The Interaction Sid for this channel. channel_sid: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ nullable: true description: The Channel Sid for this Transfer. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^QW[0-9a-fA-F]{32}$ nullable: true description: The Execution SID associated with the Transfer. type: $ref: '#/components/schemas/interaction_transfer_enum_transfer_type' status: $ref: '#/components/schemas/interaction_transfer_enum_transfer_status' from: type: string minLength: 34 maxLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ nullable: true description: The SID of the Participant initiating the Transfer. to: type: string nullable: true description: The SID of the Participant receiving the Transfer. note_sid: type: string minLength: 34 maxLength: 34 pattern: ^KQ[0-9a-fA-F]{32}$ nullable: true description: The SID of the Note associated with the Transfer. summary_sid: type: string minLength: 34 maxLength: 34 pattern: ^KQ[0-9a-fA-F]{32}$ nullable: true description: The SID of the Summary associated with the Transfer. date_created: type: string format: date-time nullable: true description: The date and time when the Transfer was created. date_updated: type: string format: date-time nullable: true description: The date and time when the Transfer was last updated. url: type: string format: uri nullable: true interaction_transfer_enum_transfer_status: type: string enum: - active - failed - completed description: 'The status of the Transfer. Can be: `active`, `completed`, `failed`.' interaction_transfer_enum_transfer_type: type: string enum: - warm - cold - external description: 'The type of the Transfer. Can be: `cold`, `warm`.' flex.v1.plugin: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource. unique_name: type: string nullable: true description: The name that uniquely identifies this Flex Plugin resource. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The friendly name this Flex Plugin resource. x-twilio: pii: handling: standard deleteSla: 30 description: type: string nullable: true description: A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long x-twilio: pii: handling: standard deleteSla: 30 archived: type: boolean nullable: true description: Whether the Flex Plugin is archived. The default value is false. date_created: type: string format: date-time nullable: true description: The date and time in GMT-7 when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT-7 when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin resource. links: type: object format: uri-map nullable: true flex.v1.plugin_archive: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FP[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource. unique_name: type: string nullable: true description: The name that uniquely identifies this Flex Plugin resource. x-twilio: pii: handling: standard deleteSla: 30 friendly_name: type: string nullable: true description: The friendly name this Flex Plugin resource. x-twilio: pii: handling: standard deleteSla: 30 description: type: string nullable: true description: A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long x-twilio: pii: handling: standard deleteSla: 30 archived: type: boolean nullable: true description: Whether the Flex Plugin is archived. The default value is false. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin resource. flex.v1.plugin_configuration: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin Configuration resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource. name: type: string nullable: true description: The name of this Flex Plugin Configuration. description: type: string nullable: true description: The description of the Flex Plugin Configuration resource. x-twilio: pii: handling: standard deleteSla: 30 archived: type: boolean nullable: true description: Whether the Flex Plugin Configuration is archived. The default value is false. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin Configuration resource. links: type: object format: uri-map nullable: true flex.v1.plugin_configuration_archive: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin Configuration resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource. name: type: string nullable: true description: The name of this Flex Plugin Configuration. description: type: string nullable: true description: The description of the Flex Plugin Configuration resource. x-twilio: pii: handling: standard deleteSla: 30 archived: type: boolean nullable: true description: Whether the Flex Plugin Configuration is archived. The default value is false. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin Configuration resource. flex.v1.plugin_release: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FK[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Plugin Release resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Plugin Release resource and owns this resource. configuration_sid: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ nullable: true description: The SID of the Plugin Configuration resource to release. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin Release was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Plugin Release resource. flex.v1.plugin.plugin_version: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin Version resource. plugin_sid: type: string minLength: 34 maxLength: 34 pattern: ^FP[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Plugin resource this Flex Plugin Version belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource. version: type: string nullable: true description: The unique version of this Flex Plugin Version. plugin_url: type: string format: uri nullable: true description: The URL of where the Flex Plugin Version JavaScript bundle is hosted on. x-twilio: pii: handling: standard deleteSla: 30 changelog: type: string nullable: true description: A changelog that describes the changes this Flex Plugin Version brings. x-twilio: pii: handling: standard deleteSla: 30 private: type: boolean nullable: true description: Whether the Flex Plugin Version is validated. The default value is false. archived: type: boolean nullable: true description: Whether the Flex Plugin Version is archived. The default value is false. validated: type: boolean nullable: true date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin Version resource. flex.v1.plugin_version_archive: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FV[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flex Plugin Version resource. plugin_sid: type: string minLength: 34 maxLength: 34 pattern: ^FP[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Plugin resource this Flex Plugin Version belongs to. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource. version: type: string nullable: true description: The unique version of this Flex Plugin Version. plugin_url: type: string format: uri nullable: true description: The URL of where the Flex Plugin Version JavaScript bundle is hosted on. x-twilio: pii: handling: standard deleteSla: 30 changelog: type: string nullable: true description: A changelog that describes the changes this Flex Plugin Version brings. x-twilio: pii: handling: standard deleteSla: 30 private: type: boolean nullable: true description: Whether to inject credentials while accessing this Plugin Version. The default value is false. archived: type: boolean nullable: true description: Whether the Flex Plugin Version is archived. The default value is false. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the Flex Plugin Version resource. flex.v1.provisioning_status: type: object properties: status: $ref: '#/components/schemas/provisioning_status_enum_status' url: type: string format: uri nullable: true description: The absolute URL of the resource. provisioning_status_enum_status: type: string enum: - active - in-progress - not-configured - failed description: Email Provisioning Status transfer_enum_transfer_status: type: string enum: - active - failed - completed transfer_enum_transfer_type: type: string enum: - warm - cold - external flex.v1.web_channel: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow. flex_flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flex Flow. sid: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the WebChannel resource. url: type: string format: uri nullable: true description: The absolute URL of the WebChannel resource. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. web_channel_enum_chat_status: type: string enum: - inactive info: title: Twilio - Flex description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/Channels: servers: - url: https://flex-api.twilio.com description: Flex chat channels x-twilio: defaultOutputProperties: - sid - flex_flow_sid - user_sid - task_sid mountName: channel pathType: list get: description: '' summary: '' tags: - FlexV1Channel parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: flex_chat_channels: type: array items: $ref: '#/components/schemas/flex.v1.channel' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListChannelResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 next_page_url: null key: flex_chat_channels flex_chat_channels: - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0 next_page_url: null key: flex_chat_channels flex_chat_channels: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListChannel post: description: '' summary: '' tags: - FlexV1Channel responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.channel' examples: create: value: flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateChannelRequest properties: FlexFlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ description: The SID of the Flex Flow. Identity: type: string description: The `identity` value that uniquely identifies the new resource's chat User. ChatUserFriendlyName: type: string description: The chat participant's friendly name. ChatFriendlyName: type: string description: The chat channel's friendly name. Target: type: string description: The Target Contact Identity, for example the phone number of an SMS. ChatUniqueName: type: string description: The chat channel's unique name. PreEngagementData: type: string description: The pre-engagement data. TaskSid: type: string minLength: 34 maxLength: 34 pattern: ^WT[0-9a-fA-F]{32}$ description: The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external` TaskAttributes: type: string description: The Task attributes to be added for the TaskRouter Task. LongLived: type: boolean description: Whether to create the channel as long-lived. required: - FlexFlowSid - Identity - ChatUserFriendlyName - ChatFriendlyName examples: create: value: FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Target: def Identity: abc ChatUserFriendlyName: friendly2 ChatFriendlyName: friendly1 ChatUniqueName: unique PreEngagementData: '{}' TaskSid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa TaskAttributes: '{}' LongLived: true /v1/Channels/{Sid}: servers: - url: https://flex-api.twilio.com description: Flex chat channels x-twilio: defaultOutputProperties: - sid - flex_flow_sid - user_sid - task_sid mountName: channel pathType: instance get: description: '' summary: '' tags: - FlexV1Channel parameters: - name: Sid in: path description: The SID of the Flex chat channel resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.channel' examples: fetch: value: flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa user_sid: USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchChannel delete: description: '' summary: '' tags: - FlexV1Channel parameters: - name: Sid in: path description: The SID of the Flex chat channel resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteChannel /v1/Configuration: servers: - url: https://flex-api.twilio.com description: Configuration for a Flex instance x-twilio: defaultOutputProperties: - status - ui_language - ui_version - service_version pathType: instance get: description: '' summary: '' tags: - FlexV1Configuration parameters: - name: UiVersion in: query description: The Pinned UI version of the Configuration resource to fetch. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.configuration' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' attributes: main_attribute: some_attribute status: ok taskrouter_workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_target_workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_target_taskqueue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_taskqueues: - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab targettable: true - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac targettable: false taskrouter_skills: - name: sales multivalue: false minimum: 0 maximum: 0 - name: support multivalue: true minimum: 0 maximum: 10 taskrouter_worker_channels: agent: - name: default availability: true capacity: 1 - name: voice availability: false capacity: 2 supervisor: - name: default availability: true capacity: 2 taskrouter_worker_attributes: agent: region: us-east supervisor: region: us taskrouter_offline_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa runtime_domain: https://flex.twilio.com messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ui_language: en ui_attributes: {} ui_dependencies: {} ui_version: '1.0' service_version: '1.0' call_recording_enabled: true call_recording_webhook_url: https://www.example.com/call-recording crm_enabled: true crm_type: custom crm_callback_url: https://crm.com/a crm_fallback_url: https://crm.com/b crm_attributes: crm_attribute: some_crm public_attributes: public: test plugin_service_enabled: true plugin_service_attributes: agent-logger: ^3.10.5 typewriter: ^7.0.1 integrations: - name: twilio type: http active: true config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' logo: logo1 author: somebody1 - name: twilio-stage type: http active: false config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' outbound_call_flows: default: caller_id: '+12345' queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa location: EE workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa queue_stats_configuration: default: service_level_threshold: 20 short_abandoned_threshold: 5 reset_timezone: America/New_York reset_time: 00:00 queue_configurations: - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reset_timezone: Europe/Tallinn reset_time: 01:00 - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab reset_timezone: Europe/Paris reset_time: 02:00 queue_channel_configurations: - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_level_threshold: 10 short_abandoned_threshold: 10 - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab service_level_threshold: 30 short_abandoned_threshold: 15 serverless_service_sids: - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab notifications: enabled: true mode: whenNotInFocus markdown: enabled: false mode: readOnly flex_insights_hr: advanced_reporting_enabled: true advanced_reporting_workspaces: - id: ID_1 timezone: America/Los_Angeles workspace_id: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - id: ID_2 timezone: Etc/UTC url: https://flex-api.twilio.com/v1/Configuration flex_insights_drilldown: true flex_url: https://flex.twilio.com channel_configs: - address_type: sms cbm_attachments: enabled: true number_of_attachments: 10 max_file_size: 157286400 max_total_file_size: 157286400 accepted_extensions: - jpg - jpeg - png - gif - txt - pdf - address_type: whatsapp cbm_attachments: enabled: true number_of_attachments: 1 max_file_size: 16777216 max_total_file_size: 67108864 accepted_extensions: - jpg - jpeg - png - amr - mp3 - mp4 - pdf - heic - oga debugger_integration: enabled: false console_errors_included: false flex_ui_status_report: enabled: false agent_conv_end_methods: enabled: - Leave dateUpdated: '2023-08-16T12:22:06.787Z' citrix_voice_vdi: enabled: false offline_config: presence: true presence_ttl: 30 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConfiguration post: description: '' summary: '' tags: - FlexV1Configuration responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.configuration' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' attributes: main_attribute: some_attribute status: ok taskrouter_workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_target_workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_target_taskqueue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa taskrouter_taskqueues: - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab targettable: true - sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac targettable: false taskrouter_skills: - name: sales multivalue: false minimum: 0 maximum: 0 - name: support multivalue: true minimum: 0 maximum: 10 taskrouter_worker_channels: agent: - name: default availability: true capacity: 1 - name: voice availability: false capacity: 2 supervisor: - name: default availability: true capacity: 2 taskrouter_worker_attributes: agent: region: us-east supervisor: region: us taskrouter_offline_activity_sid: WAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa runtime_domain: https://flex.twilio.com messaging_service_instance_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa chat_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_service_instance_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flex_instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ui_language: en ui_attributes: {} ui_dependencies: {} ui_version: '1.0' service_version: '1.0' call_recording_enabled: true call_recording_webhook_url: https://www.example.com/call-recording crm_enabled: true crm_type: custom crm_callback_url: https://crm.com/a crm_fallback_url: https://crm.com/b crm_attributes: crm_attribute: some_crm public_attributes: public: test plugin_service_enabled: false plugin_service_attributes: agent-logger: ^3.10.5 typewriter: ^7.0.1 integrations: - name: twilio type: http active: true config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' logo: logo1 author: somebody1 - name: twilio-stage type: http active: false config: '{"callback":"twilio.com/cb","allowed_methods":["GET","POST"]}' outbound_call_flows: default: caller_id: '+12345' queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa location: EE workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa queue_stats_configuration: default: service_level_threshold: 20 short_abandoned_threshold: 5 reset_timezone: America/New_York reset_time: 00:00 queue_configurations: - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reset_timezone: Europe/Tallinn reset_time: 01:00 - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab reset_timezone: Europe/Paris reset_time: 02:00 queue_channel_configurations: - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_level_threshold: 10 short_abandoned_threshold: 10 - queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab service_level_threshold: 30 short_abandoned_threshold: 15 serverless_service_sids: - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - ZSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab notifications: enabled: true mode: whenNotInFocus markdown: enabled: false mode: readOnly flex_insights_hr: advanced_reporting_enabled: true advanced_reporting_workspaces: - id: ID_1 timezone: America/Los_Angeles workspace_id: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - id: ID_2 timezone: Etc/UTC url: https://flex-api.twilio.com/v1/Configuration flex_insights_drilldown: true flex_url: https://flex.twilio.com channel_configs: - address_type: sms cbm_attachments: enabled: true number_of_attachments: 10 max_file_size: 157286400 max_total_file_size: 157286400 accepted_extensions: - jpg - jpeg - png - gif - txt - pdf debugger_integration: enabled: false console_errors_included: false flex_ui_status_report: enabled: false agent_conv_end_methods: enabled: - Leave dateUpdated: '2023-08-16T12:22:06.787Z' citrix_voice_vdi: enabled: false offline_config: presence: true presence_ttl: 30 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateConfiguration requestBody: content: application/json: schema: type: object title: UpdateConfigurationRequest properties: {} /v1/PluginService/Configurations/{ConfigurationSid}/Plugins: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - plugin_sid - plugin_version_sid - plugin_url - phase parent: /PluginService/Configurations/{Sid} className: configured_plugin pathType: list get: description: '' summary: '' tags: - FlexV1ConfiguredPlugin parameters: - name: ConfigurationSid in: path description: The SID of the Flex Plugin Configuration the resource to belongs to. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: plugins: type: array items: $ref: '#/components/schemas/flex.v1.plugin_configuration.configured_plugin' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListConfiguredPluginResponse examples: readEmpty: value: plugins: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0 next_page_url: null key: plugins readFull: value: plugins: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_version_sid: PVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa phase: 3 plugin_url: https://sample.twil.io/plugin.js unique_name: sample-plugin plugin_archived: false friendly_name: sample plugin description: the sample plugin version: 1.0.0 plugin_version_archived: false changelog: this is a changelog private: true date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins?PageSize=50&Page=0 next_page_url: null key: plugins headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListConfiguredPlugin /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - plugin_sid - plugin_version_sid - plugin_url - phase parent: /PluginService/Configurations/{Sid} className: configured_plugin pathType: instance get: description: '' summary: '' tags: - FlexV1ConfiguredPlugin parameters: - name: ConfigurationSid in: path description: The SID of the Flex Plugin Configuration the resource to belongs to. schema: type: string required: true - name: PluginSid in: path description: The unique string that we created to identify the Flex Plugin resource. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_configuration.configured_plugin' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_version_sid: PVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa phase: 3 plugin_url: https://sample.twil.io/plugin.js unique_name: sample-plugin plugin_archived: false friendly_name: sample plugin description: the sample plugin version: 1.0.0 plugin_version_archived: false changelog: this is a changelog private: true date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchConfiguredPlugin /v1/FlexFlows: servers: - url: https://flex-api.twilio.com description: Flex Flow x-twilio: defaultOutputProperties: - sid - friendly_name - channel_type - integration_type mountName: flex_flow pathType: list get: description: '' summary: '' tags: - FlexV1FlexFlow parameters: - name: FriendlyName in: query description: The `friendly_name` of the Flex Flow resources to read. schema: type: string x-twilio: pii: handling: standard deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: flex_flows: type: array items: $ref: '#/components/schemas/flex.v1.flex_flow' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListFlexFlowResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 next_page_url: null key: flex_flows flex_flows: - sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' friendly_name: friendly_name chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_type: sms contact_identity: '12345' enabled: true integration_type: studio integration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa retry_count: 1 long_lived: true janitor_enabled: true url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/FlexFlows?PageSize=50&Page=0 next_page_url: null key: flex_flows flex_flows: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListFlexFlow post: description: '' summary: '' tags: - FlexV1FlexFlow responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' examples: create: value: sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' friendly_name: friendly_name chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_type: sms contact_identity: '12345' enabled: true integration_type: studio integration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa retry_count: 1 long_lived: true janitor_enabled: true url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateFlexFlow requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateFlexFlowRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the Flex Flow resource. ChatServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: The SID of the chat service. ChannelType: $ref: '#/components/schemas/flex_flow_enum_channel_type' ContactIdentity: type: string description: The channel contact's Identity. Enabled: type: boolean description: Whether the new Flex Flow is enabled. IntegrationType: $ref: '#/components/schemas/flex_flow_enum_integration_type' Integration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The SID of the Studio Flow. Required when `integrationType` is `studio`. Integration.Url: type: string format: uri description: The URL of the external webhook. Required when `integrationType` is `external`. Integration.WorkspaceSid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ description: The Workspace SID for a new Task. Required when `integrationType` is `task`. Integration.WorkflowSid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ description: The Workflow SID for a new Task. Required when `integrationType` is `task`. Integration.Channel: type: string description: The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`. Integration.Timeout: type: integer description: The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise. Integration.Priority: type: integer description: The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise. Integration.CreationOnMessage: type: boolean description: In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging. LongLived: type: boolean description: When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`. JanitorEnabled: type: boolean description: When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`. Integration.RetryCount: type: integer description: The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise. required: - FriendlyName - ChatServiceSid - ChannelType examples: create: value: FriendlyName: friendly_name ChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ChannelType: sms ContactIdentity: '12345' Enabled: true IntegrationType: studio Integration.FlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa LongLived: true JanitorEnabled: true Integration.RetryCount: 1 /v1/FlexFlows/{Sid}: servers: - url: https://flex-api.twilio.com description: Flex Flow x-twilio: defaultOutputProperties: - sid - friendly_name - channel_type - integration_type mountName: flex_flow pathType: instance get: description: '' summary: '' tags: - FlexV1FlexFlow parameters: - name: Sid in: path description: The SID of the Flex Flow resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' examples: fetch: value: sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' friendly_name: friendly_name chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_type: sms contact_identity: '12345' enabled: true integration_type: studio integration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa retry_count: 1 long_lived: true janitor_enabled: true url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchFlexFlow post: description: '' summary: '' tags: - FlexV1FlexFlow parameters: - name: Sid in: path description: The SID of the Flex Flow resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.flex_flow' examples: update: value: sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' friendly_name: friendly_name chat_service_sid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_type: sms contact_identity: '12345' enabled: true integration_type: studio integration: flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa retry_count: 1 long_lived: true janitor_enabled: true url: https://flex-api.twilio.com/v1/FlexFlows/FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateFlexFlow requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateFlexFlowRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the Flex Flow resource. ChatServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^IS[0-9a-fA-F]{32}$ description: The SID of the chat service. ChannelType: $ref: '#/components/schemas/flex_flow_enum_channel_type' ContactIdentity: type: string description: The channel contact's Identity. Enabled: type: boolean description: Whether the new Flex Flow is enabled. IntegrationType: $ref: '#/components/schemas/flex_flow_enum_integration_type' Integration.FlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ description: The SID of the Studio Flow. Required when `integrationType` is `studio`. Integration.Url: type: string format: uri description: The URL of the external webhook. Required when `integrationType` is `external`. Integration.WorkspaceSid: type: string minLength: 34 maxLength: 34 pattern: ^WS[0-9a-fA-F]{32}$ description: The Workspace SID for a new Task. Required when `integrationType` is `task`. Integration.WorkflowSid: type: string minLength: 34 maxLength: 34 pattern: ^WW[0-9a-fA-F]{32}$ description: The Workflow SID for a new Task. Required when `integrationType` is `task`. Integration.Channel: type: string description: The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`. Integration.Timeout: type: integer description: The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise. Integration.Priority: type: integer description: The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise. Integration.CreationOnMessage: type: boolean description: In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging. LongLived: type: boolean description: When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`. JanitorEnabled: type: boolean description: When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`. Integration.RetryCount: type: integer description: The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise. examples: update: value: FriendlyName: friendly_name ChatServiceSid: ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ChannelType: sms ContactIdentity: '12345' Enabled: true IntegrationType: studio Integration.FlowSid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa LongLived: true JanitorEnabled: true Integration.RetryCount: 1 delete: description: '' summary: '' tags: - FlexV1FlexFlow parameters: - name: Sid in: path description: The SID of the Flex Flow resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFlexFlow /v1/Insights/QualityManagement/Assessments: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - assessment className: assessments pathType: list post: description: Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question. summary: Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question. tags: - FlexV1Assessments parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc user_name: Supervisor user_email: supervisor@example.com answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 answer_text: Fair timestamp: '1657329694199' assessment: questionnaire: questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Customer Experience question: question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Active listening category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsAssessments requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInsightsAssessmentsRequest properties: CategorySid: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ description: 'The SID of the category ' CategoryName: type: string description: The name of the category SegmentId: type: string description: Segment Id of the conversation AgentId: type: string description: The id of the Agent Offset: type: number description: The offset of the conversation. MetricId: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ description: The question SID selected for assessment MetricName: type: string description: The question name of the assessment AnswerText: type: string description: The answer text selected by user AnswerId: type: string description: The id of the answer selected by user QuestionnaireSid: type: string minLength: 34 maxLength: 34 pattern: ^GM[0-9a-fA-F]{32}$ description: Questionnaire SID of the associated question required: - CategorySid - CategoryName - SegmentId - AgentId - Offset - MetricId - MetricName - AnswerText - AnswerId - QuestionnaireSid examples: create: value: CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa CategoryName: Good for Training SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 Offset: '6.985619' MetricId: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa MetricName: Active listening AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 AnswerText: Fair QuestionnaireSid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: Get assessments done for a conversation by logged in user summary: Get assessments done for a conversation by logged in user tags: - FlexV1Assessments parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: SegmentId in: query description: The id of the segment. schema: type: string examples: readBySegmentId: value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc readEmpty: value: dbdf1f7b-c776-5e78-9676-98a397fb3cdc - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: assessments: type: array items: $ref: '#/components/schemas/flex.v1.insights_assessments' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsAssessmentsResponse examples: readBySegmentId: value: assessments: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: dbdf1f7b-c776-5e78-9676-98a397fb3cdc user_name: Supervisor user_email: supervisor@example.com answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 answer_text: Fair timestamp: '1657329694199' assessment: questionnaire: questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Customer Experience question: question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Active listening category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 key: assessments next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 readEmpty: value: assessments: [] meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 key: assessments next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments?SegmentId=dbdf1f7b-c776-5e78-9676-98a397fb3cdc&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsAssessments /v1/Insights/QualityManagement/Assessments/{AssessmentSid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - assessment className: assessments pathType: instance post: description: Update a specific Assessment assessed earlier summary: Update a specific Assessment assessed earlier tags: - FlexV1Assessments parameters: - name: AssessmentSid in: path description: The SID of the assessment to be modified schema: type: string minLength: 34 maxLength: 34 pattern: ^FM[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 user_name: Supervisor user_email: supervisor@example.com answer_id: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 answer_text: Fair timestamp: '1657329694199' assessment: questionnaire: questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Customer Experience question: question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Active listening category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsAssessments requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInsightsAssessmentsRequest properties: Offset: type: number description: The offset of the conversation AnswerText: type: string description: The answer text selected by user AnswerId: type: string description: The id of the answer selected by user required: - Offset - AnswerText - AnswerId examples: update: value: Offset: '6.985619' AnswerId: ed8697d3-558d-46c3-9b73-cd21cd93cbb3 AnswerText: Fair /v1/Insights/QualityManagement/Assessments/Comments: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - assessment_sid - comment mountName: insights_assessments_comment pathType: list post: description: To create a comment assessment for a conversation summary: To create a comment assessment for a conversation tags: - FlexV1InsightsAssessmentsComment parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_assessments_comment' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 user_name: Linda Houghton user_email: linda.houghton@vacasa.com timestamp: '1657329694199' comment: comment: log0zu0268 category: category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsAssessmentsComment requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInsightsAssessmentsCommentRequest properties: CategoryId: type: string description: The ID of the category CategoryName: type: string description: The name of the category Comment: type: string description: The Assessment comment. SegmentId: type: string description: The id of the segment. AgentId: type: string description: The id of the agent. Offset: type: number description: The offset required: - CategoryId - CategoryName - Comment - SegmentId - AgentId - Offset examples: create: value: CategoryId: 4b4e78e4-4f05-49e2-bf52-0973c5cde418 CategoryName: Good for Training Comment: log0zu0268 SegmentId: dbdf1f7b-c776-5e78-9676-98a397fb3cdc AgentId: 583fcaa6-a4ef-5447-9077-900421e37a61 Offset: '6.985619' get: description: To create a comment assessment for a conversation summary: To create a comment assessment for a conversation tags: - FlexV1InsightsAssessmentsComment parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: SegmentId in: query description: The id of the segment. schema: type: string examples: readBySegmentId: value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 readEmpty: value: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 - name: AgentId in: query description: The id of the agent. schema: type: string examples: readByAgentId: value: 5d80ee80-7608-55df-b2b2-5ab5608b9831 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: comments: type: array items: $ref: '#/components/schemas/flex.v1.insights_assessments_comment' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsAssessmentsCommentResponse examples: readBySegmentId: value: comments: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 user_name: Linda Houghton user_email: linda.houghton@vacasa.com timestamp: '1657329694199' comment: comment: log0zu0268 category: category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 key: comments next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 readByAgentId: value: comments: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa assessment_sid: FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa offset: '0.0' report: true weight: '1' agent_id: 5d80ee80-7608-55df-b2b2-5ab5608b9831 segment_id: 0105be7a-9b87-51f1-8df8-aa74ddb9c4a7 user_name: Linda Houghton user_email: linda.houghton@vacasa.com timestamp: '1657329694199' comment: comment: log0zu0268 category: category_id: c9ba34ca-7174-4dcd-ab3e-91fbb1932f1e name: Good for Training url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments/FMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 key: comments next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?AgentId=5d80ee80-7608-55df-b2b2-5ab5608b9831&PageSize=50&Page=0 readEmpty: value: comments: [] meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 key: comments next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Assessments/Comments?SegmentId=0105be7a-9b87-51f1-8df8-aa74ddb9c4a7&PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsAssessmentsComment /v1/Insights/Conversations: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - conversation_id - account_id - segment_count - segments mountName: insights_conversations className: insights_conversations pathType: list get: description: To get conversation with segment id summary: To get conversation with segment id tags: - FlexV1InsightsConversations parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: SegmentId in: query description: Unique Id of the segment for which conversation details needs to be fetched schema: type: string examples: readEmpty: value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 readFull: value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: conversations: type: array items: $ref: '#/components/schemas/flex.v1.insights_conversations' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsConversationsResponse examples: readEmpty: value: conversations: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 next_page_url: null key: conversations readFull: value: conversations: - account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d conversation_id: 2cb2452a-c6d9-564d-b285-b5404f073031 segment_count: 2 segments: - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a4 order: 0 offset: 1.542 talk_time: 18 timestamp: '2022-05-11T16:02:27.659Z' agent_name: First Agent - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 order: 0 offset: 1.211 talk_time: 10 timestamp: '2022-05-21T16:02:27.659Z' agent_name: Second Agent meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/Conversations?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a4&PageSize=50&Page=0 next_page_url: null key: conversations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsConversations /v1/Insights/QualityManagement/Questionnaires: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - questionnaire_sid - name mountName: insights_questionnaires className: insights_questionnaires pathType: list post: description: To create a Questionnaire summary: To create a Questionnaire tags: - FlexV1InsightsQuestionnaires parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abc description: description active: false questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnaires requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInsightsQuestionnairesRequest properties: Name: type: string description: The name of this questionnaire Description: type: string description: The description of this questionnaire Active: type: boolean description: The flag to enable or disable questionnaire QuestionSids: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ description: The list of questions sids under a questionnaire required: - Name examples: create: value: Name: abc Description: description Active: false QuestionSids: - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee get: description: To get all questionnaires with questions summary: To get all questionnaires with questions tags: - FlexV1InsightsQuestionnaires parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: IncludeInactive in: query description: Flag indicating whether to include inactive questionnaires or not schema: type: boolean examples: readEmpty: value: true readFull: value: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: questionnaires: type: array items: $ref: '#/components/schemas/flex.v1.insights_questionnaires' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsQuestionnairesResponse examples: readEmpty: value: questionnaires: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=true&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=true&PageSize=50&Page=0 next_page_url: null key: questionnaires readFull: value: questionnaires: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abc description: description active: false questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abc description: description active: true questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=true&PageSize=50&Page=0 key: questionnaires next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?IncludeInactive=true&PageSize=50&Page=0 readActiveQuestionnaires: value: questionnaires: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: efg description: description active: true questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 key: questionnaires next_page_url: null page: 0 page_size: 50 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires?PageSize=50&Page=0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnaires /v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - questionnaire_sid - name mountName: insights_questionnaires className: insights_questionnaires pathType: instance post: description: To update the questionnaire summary: To update the questionnaire tags: - FlexV1InsightsQuestionnaires parameters: - name: QuestionnaireSid in: path description: The SID of the questionnaire schema: type: string minLength: 34 maxLength: 34 pattern: ^GM[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abc description: description active: true questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnaires requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInsightsQuestionnairesRequest properties: Active: type: boolean description: The flag to enable or disable questionnaire Name: type: string description: The name of this questionnaire Description: type: string description: The description of this questionnaire QuestionSids: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ description: The list of questions sids under a questionnaire required: - Active examples: update: value: Name: abc Description: description Active: true QuestionSids: - GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - GEeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee delete: description: To delete the questionnaire summary: To delete the questionnaire tags: - FlexV1InsightsQuestionnaires parameters: - name: QuestionnaireSid in: path description: The SID of the questionnaire schema: type: string minLength: 34 maxLength: 34 pattern: ^GM[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnaires get: description: To get the Questionnaire Detail summary: To get the Questionnaire Detail tags: - FlexV1InsightsQuestionnaires parameters: - name: QuestionnaireSid in: path description: The SID of the questionnaire schema: type: string minLength: 34 maxLength: 34 pattern: ^GM[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa questionnaire_sid: GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: efg description: description active: true questions: - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 - question: What is the total time description: time spent category: category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_name: test cat question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questionnaires/GMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInsightsQuestionnaires /v1/Insights/QualityManagement/Categories: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - category_sid - name mountName: insights_questionnaires_category pathType: list post: description: To create a category for Questions summary: To create a category for Questions tags: - FlexV1InsightsQuestionnairesCategory parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abc url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnairesCategory requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInsightsQuestionnairesCategoryRequest properties: Name: type: string description: The name of this category. required: - Name examples: create: value: Name: abc get: description: To get all the categories summary: To get all the categories tags: - FlexV1InsightsQuestionnairesCategory parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: categories: type: array items: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsQuestionnairesCategoryResponse examples: readEmpty: value: categories: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 next_page_url: null key: categories readFull: value: categories: - category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: Test1 account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories?PageSize=50&Page=0 next_page_url: null key: categories headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnairesCategory /v1/Insights/QualityManagement/Categories/{CategorySid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - category_sid - name mountName: insights_questionnaires_category pathType: instance post: description: To update the category for Questions summary: To update the category for Questions tags: - FlexV1InsightsQuestionnairesCategory parameters: - name: CategorySid in: path description: The SID of the category to be updated schema: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_category' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: abcd url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Categories/FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnairesCategory requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInsightsQuestionnairesCategoryRequest properties: Name: type: string description: The name of this category. required: - Name examples: update: value: Name: abcd delete: description: '' summary: '' tags: - FlexV1InsightsQuestionnairesCategory parameters: - name: CategorySid in: path description: The SID of the category to be deleted schema: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnairesCategory /v1/Insights/QualityManagement/Questions: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - question_sid - question mountName: insights_questionnaires_question pathType: list post: description: To create a question for a Category summary: To create a question for a Category tags: - FlexV1InsightsQuestionnairesQuestion parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa question: What is the total time question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: time spent category: category_name: test cat category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 answer_set: sort: 0 name: Yes, No answers: - sort: 0 score: 100 description: Yes. name: 'Yes' id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 - sort: 1 score: 0 description: No or a very poor. name: 'No' id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 type: select id: a6a8a54f-5305-4aec-b92c-a6e429932f58 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsQuestionnairesQuestion requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInsightsQuestionnairesQuestionRequest properties: CategorySid: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ description: The SID of the category Question: type: string description: The question. AnswerSetId: type: string description: The answer_set for the question. AllowNa: type: boolean description: The flag to enable for disable NA for answer. Description: type: string description: The description for the question. required: - CategorySid - Question - AnswerSetId - AllowNa examples: create: value: CategorySid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Question: What is the total time Description: time spent AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 AllowNa: false get: description: To get all the question for the given categories summary: To get all the question for the given categories tags: - FlexV1InsightsQuestionnairesQuestion parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: CategorySid in: query description: The list of category SIDs schema: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ examples: readEmpty: value: - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee readFull: value: - FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - FYeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: questions: type: array items: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsQuestionnairesQuestionResponse examples: readEmpty: value: questions: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: questions readFull: value: questions: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa question: What is the total time question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: time spent category: category_name: test cat category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 answer_set: sort: 0 name: Yes, No answers: - sort: 0 score: 100 description: Yes. name: 'Yes' id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 - sort: 1 score: 0 description: No or a very poor. name: 'No' id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 type: select id: a6a8a54f-5305-4aec-b92c-a6e429932f58 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions?CategorySid=FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0 next_page_url: null key: questions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsQuestionnairesQuestion /v1/Insights/QualityManagement/Questions/{QuestionSid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - account_sid - question_sid - question mountName: insights_questionnaires_question pathType: instance post: description: To update the question summary: To update the question tags: - FlexV1InsightsQuestionnairesQuestion parameters: - name: QuestionSid in: path description: The SID of the question schema: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_questionnaires_question' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa question: What is the total time question_sid: GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: time spent category: category_name: test cat category_sid: FYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa answer_set_id: a6a8a54f-5305-4aec-b92c-a6e429932f58 allow_na: false usage: 0 answer_set: sort: 0 name: Yes, No answers: - sort: 0 score: 100 description: Yes. name: 'Yes' id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 - sort: 1 score: 0 description: No or a very poor. name: 'No' id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 type: select id: a6a8a54f-5305-4aec-b92c-a6e429932f58 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Questions/GEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInsightsQuestionnairesQuestion requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInsightsQuestionnairesQuestionRequest properties: AllowNa: type: boolean description: The flag to enable for disable NA for answer. CategorySid: type: string minLength: 34 maxLength: 34 pattern: ^FY[0-9a-fA-F]{32}$ description: The SID of the category Question: type: string description: The question. Description: type: string description: The description for the question. AnswerSetId: type: string description: The answer_set for the question. required: - AllowNa examples: update: value: Question: What is the total time Description: time spent AnswerSetId: a6a8a54f-5305-4aec-b92c-a6e429932f58 AllowNa: false delete: description: '' summary: '' tags: - FlexV1InsightsQuestionnairesQuestion parameters: - name: QuestionSid in: path description: The SID of the question schema: type: string minLength: 34 maxLength: 34 pattern: ^GE[0-9a-fA-F]{32}$ required: true - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteInsightsQuestionnairesQuestion /v1/Insights/Segments: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - segment_id - external_id - account_id - agent_id - queue mountName: insights_segments className: insights_segments pathType: list get: description: To get segments for given reservation Ids summary: To get segments for given reservation Ids tags: - FlexV1InsightsSegments parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string - name: SegmentId in: query description: To unique id of the segment schema: type: string examples: readBySegmentId: value: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 - name: ReservationId in: query description: The list of reservation Ids schema: type: array items: type: string minLength: 34 maxLength: 34 pattern: ^WR[0-9a-fA-F]{32}$ examples: readEmpty: value: - WReeeff42d5326cfdaa0f7a1181d00f1b1 - WReeeff42d5326cfdaa0f7a1181d00f1b2 readByReservationIds: value: - WReeeff42d5326cfdaa0f7a1181d00f1b1 - WReeeff42d5326cfdaa0f7a1181d00f1b2 - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: segments: type: array items: $ref: '#/components/schemas/flex.v1.insights_segments' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInsightsSegmentsResponse examples: readEmpty: value: segments: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 next_page_url: null key: segments readByReservationIds: value: segments: - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 queue: Everyone external_contact: '+13051515226' external_segment_link_id: null date: '2022-02-08T08:00:00Z' account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d external_segment_link: null agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe agent_phone: '+13051515226' agent_name: Flex Insights agent_team_name: Everyone agent_team_name_in_hierarchy: Everyone agent_link: null customer_phone: '+420606078007' customer_name: '+420606078007' customer_link: null segment_recording_offset: null media: null assessment_type: - null assessment_percentage: - null url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/Segments?ReservationId=WReeeff42d5326cfdaa0f7a1181d00f1b1&PageSize=50&Page=0 next_page_url: null key: segments readBySegmentId: value: segments: - segment_id: 02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 external_id: EV4ab3c50aeeb9dc48c96f7290cf626a37 queue: Everyone external_contact: '+13051515226' external_segment_link_id: null date: '2022-02-08T08:00:00Z' account_id: 76e4c1c3-6f93-5d08-ae66-aad4b9092f2d external_segment_link: null agent_id: 0e4a8059-18a3-5e48-9efb-29ae3213e7fe agent_phone: '+13051515226' agent_name: Flex Insights agent_team_name: Everyone agent_team_name_in_hierarchy: Everyone agent_link: null customer_phone: '+420606078007' customer_name: '+420606078007' customer_link: null segment_recording_offset: null media: null assessment_type: - null assessment_percentage: - null url: https://flex-api.twilio.com/v1/Insights/Segments/02dd8a65-c9e3-550b-9e98-5b11abb9b3a5 meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Insights/Segments?SegmentId=02dd8a65-c9e3-550b-9e98-5b11abb9b3a5&PageSize=50&Page=0 next_page_url: null key: segments headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInsightsSegments /v1/Insights/Session: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - workspace_id - session_expiry - session_id - base_url mountName: insights_session pathType: instance post: description: To obtain session details for fetching reports and dashboards summary: To obtain session details for fetching reports and dashboards tags: - FlexV1InsightsSession parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_session' examples: create: value: session_expiry: '2022-09-27T09:28:01Z' workspace_id: clbi1eelh1x8z4.......ijpnyu session_id: "-----BEGIN PGP MESSAGE-----\n\nwcBMA11tX1FL13rp\u2026\ \u2026kHXd\n=vOBk\n-----END PGP MESSAGE-----\n" base_url: https://analytics.ytica.com/ url: https://flex-api.twilio.com/v1/Insights/Session headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInsightsSession /v1/Insights/QualityManagement/Settings/AnswerSets: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - answer_sets - answer_set_categories - not_applicable mountName: insights_settings_answer_sets className: insights_settings_answer_sets pathType: list get: description: To get the Answer Set Settings for an Account summary: To get the Answer Set Settings for an Account tags: - FlexV1InsightsSettingsAnswerSets parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_settings_answersets' examples: read: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/AnswerSets answer_sets: - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 id: a6a8a54f-5305-4aec-b92c-a6e429932f58 name: Yes, No sort: 0 type: select answers: - description: Yes. id: 4e34f701-8206-4670-b376-c9fe26bb3ca3 name: 'Yes' score: 100 sort: 0 - description: No or a very poor. id: 5e926651-fa5d-4aba-86e1-8440bb8faa6c name: 'No' score: 0 sort: 1 - category_id: 1a8cac56-826c-4f85-ac14-9104811cf184 id: 675e8803-e7ca-4002-97f6-a29490450b1b name: Good, Poor sort: 1 type: select answers: - description: Good. id: 5aa6c6c0-05cf-4952-b9f9-9fdbe18cc79d name: Good score: 100 sort: 0 - description: Poor. id: d19f1c36-8331-44cc-9944-e94cb39e35e9 name: Poor score: 0 sort: 1 answer_set_categories: - id: 1a8cac56-826c-4f85-ac14-9104811cf184 name: Two Options sort: 1 - id: 10c44902-0e6e-46b6-9378-d4665348b4b7 name: Three Options sort: 2 - id: 10c44902-0e6e-46b6-9378-d4665348b4b8 name: Rating sort: 3 not_applicable: description: Not applicable for this call id: 8dc58ae1-16ae-4e17-a357-799d06230fa3 name: N/A score: 0 sort: 0 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInsightsSettingsAnswersets /v1/Insights/QualityManagement/Settings/CommentTags: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - comments mountName: insights_settings_comment pathType: list get: description: To get the Comment Settings for an Account summary: To get the Comment Settings for an Account tags: - FlexV1InsightsSettingsComment parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_settings_comment' examples: read: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa comments: - default: false id: 4c5ba39a-e192-4c5d-a41c-b765a833665b name: Good sort: 0 url: https://flex-api.twilio.com/v1/Insights/QualityManagement/Settings/CommentTags headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInsightsSettingsComment /v1/Insights/UserRoles: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - roles mountName: insights_user_roles className: insights_user_roles pathType: instance get: description: This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user summary: This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user tags: - FlexV1InsightsUserRoles parameters: - name: Authorization in: header description: The Authorization HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.insights_user_roles' examples: fetch: value: roles: - wfo.full_access url: https://flex-api.twilio.com/v1/Insights/UserRoles headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInsightsUserRoles /v1/Interactions/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid dependentProperties: channels: mapping: interaction_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels mountName: interaction pathType: instance get: description: '' summary: '' tags: - FlexV1Interaction parameters: - name: Sid in: path description: The SID of the Interaction resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction' examples: fetch: value: sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel: type: sms sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing: properties: workflow_sid: WWxx attributes: WWxx task_channel_unique_name: sms routing_target: WKXX queue_name: WQXX interaction_context_sid: null webhook_ttid: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: channels: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInteraction post: description: Updates an interaction. summary: Updates an interaction. tags: - FlexV1Interaction parameters: - name: Sid in: path description: The SID of the Interaction resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction' examples: update: value: sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel: type: sms sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: channels: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels interaction_context_sid: null routing: null webhook_ttid: flex_interactionwebhook_01jke8z8vte4ette30t5w9h081 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInteraction requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInteractionRequest properties: WebhookTtid: type: string description: The unique identifier for Interaction level webhook examples: update: value: WebhookTtid: flex_interactionwebhook_01jke8z8vte4ette30t5w9h081 /v1/Interactions: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid dependentProperties: channels: mapping: interaction_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels mountName: interaction pathType: list post: description: Create a new Interaction. summary: Create a new Interaction. tags: - FlexV1Interaction responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction' examples: create: value: sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel: type: sms sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing: reservation: null properties: date_updated: 1634845217 task_queue_entered_date: 1634845217 workflow_name: Default Fifo Workflow age_in_queue: 0 task_channel_unique_name: default assignment_status: pending queue_name: Sample Queue assignmentCounter: 0 priority: 0 sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reason: '' attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer phone address","name":"customer name"},"conversations":{"initiated_by":"customer","conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","initiatedBy":"customer","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","direction":"inbound"}' task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa age: 0 workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa timeout: 86400 date_created: 1634845217 addons: '{}' queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_context_sid: null webhook_ttid: flex_interactionwebhook_00000000000000000000000000 url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: channels: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInteraction requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInteractionRequest properties: Channel: description: The Interaction's channel. Routing: description: The Interaction's routing logic. InteractionContextSid: type: string minLength: 34 maxLength: 34 pattern: ^HQ[0-9a-fA-F]{32}$ description: The Interaction context sid is used for adding a context lookup sid WebhookTtid: type: string description: The unique identifier for Interaction level webhook required: - Channel examples: create: value: Channel: '{"type":"sms","initiated_by":"customer"}' Routing: '{}' InteractionContextSid: interaction_context_sid WebhookTtid: flex_interactionwebhook_00000000000000000000000000 /v1/Interactions/{InteractionSid}/Channels/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid dependentProperties: invites: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites participants: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants transfers: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Transfers parent: /Interactions/{Sid} className: interaction_channel pathType: instance get: description: Fetch a Channel for an Interaction. summary: Fetch a Channel for an Interaction. tags: - FlexV1InteractionChannel parameters: - name: InteractionSid in: path description: The unique string created by Twilio to identify an Interaction resource, prefixed with KD. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' examples: fetch: value: sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 type: chat interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: closed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInteractionChannel post: description: Update an existing Interaction Channel. summary: Update an existing Interaction Channel. tags: - FlexV1InteractionChannel parameters: - name: InteractionSid in: path description: The unique string created by Twilio to identify an Interaction resource, prefixed with KD. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' examples: update: value: sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: chat status: closed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers updateStatusClosed: value: sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: chat status: failed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers updateStatusInactive: value: sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: email status: inactive error_code: null error_message: '' url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInteractionChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInteractionChannelRequest properties: Status: $ref: '#/components/schemas/interaction_channel_enum_update_channel_status' Routing: description: It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`. required: - Status examples: update: value: Status: closed updateStatusClosed: value: Status: closed updateStatusInactive: value: Status: inactive Routing: '{"status":"closed"}' /v1/Interactions/{InteractionSid}/Channels: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid dependentProperties: invites: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites participants: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants transfers: mapping: interaction_sid: interaction_sid channel_sid: sid resource_url: /v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Transfers parent: /Interactions/{Sid} className: interaction_channel pathType: list get: description: List all Channels for an Interaction. summary: List all Channels for an Interaction. tags: - FlexV1InteractionChannel parameters: - name: InteractionSid in: path description: The unique string created by Twilio to identify an Interaction resource, prefixed with KD. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: channels: type: array items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInteractionChannelResponse examples: read: value: channels: - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 type: chat interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: closed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Transfers - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 type: sms interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: active error_code: null error_message: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2/Transfers - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 type: email interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa3/Transfers - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 type: voice interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: setup error_code: null error_message: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa4/Transfers - sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 type: gbm interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: failed error_code: 19025 error_message: Channel validation error url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5 links: participants: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Participants invites: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Invites transfers: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa5/Transfers meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels?PageSize=50&Page=0 next_page_url: null key: channels headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannel /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_invite pathType: list post: description: Invite an Agent or a TaskQueue to a Channel. summary: Invite an Agent or a TaskQueue to a Channel. tags: - FlexV1InteractionChannelInvite parameters: - name: InteractionSid in: path description: The Interaction SID for this Channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel SID for this Invite. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' examples: create: value: sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing: reservation: null properties: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: 1634845217 date_updated: 1634845217 attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' assignment_status: pending workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workflow_name: Default Fifo Workflow queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa queue_name: Sample Queue priority: 0 age: 0 reason: '' timeout: 86400 assignmentCounter: 0 task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_channel_unique_name: default routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_queue_entered_date: 1634845217 age_in_queue: 0 addons: '{}' url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInteractionChannelInvite requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInteractionChannelInviteRequest properties: Routing: description: The Interaction's routing logic. required: - Routing examples: create: value: Routing: '{"properties":{"workspace_sid":"WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","workflow_sid":"WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","worker_sid":"WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","queue_sid":"WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","attributes":{"customerName":"customer name","customerAddress":"customer email address"}}}' get: description: List all Invites for a Channel. summary: List all Invites for a Channel. tags: - FlexV1InteractionChannelInvite parameters: - name: InteractionSid in: path description: The Interaction SID for this Channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel SID for this Participant. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: invites: type: array items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInteractionChannelInviteResponse examples: read: value: invites: - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing: reservation: null properties: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: 1634845217 date_updated: 1634845217 attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' assignment_status: pending workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workflow_name: Default Fifo Workflow queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa queue_name: Sample Queue priority: 0 age: 0 reason: '' timeout: 86400 assignmentCounter: 0 task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_channel_unique_name: default routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_queue_entered_date: 1634845217 age_in_queue: 0 addons: '{}' url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 - sid: KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa routing: reservation: null properties: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workspace_sid: WSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: 1634845217 date_updated: 1634845217 attributes: '{"customerAddress":"customer phone address","flexChannelInviteSid":"KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","conversationSid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","channelType":"sms","customers":{"phone":"customer phone address","name":"customer name"},"conversations":{"conversation_id":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","media":[{"type":"ChatTranscript","sid":"CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]},"customerName":"customer name","flexInteractionChannelSid":"UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","flexInteractionSid":"KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' assignment_status: pending workflow_sid: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa workflow_name: Default Fifo Workflow queue_sid: WQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa queue_name: Sample Queue priority: 0 age: 0 reason: '' timeout: 86400 assignmentCounter: 0 task_channel_sid: TCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_channel_unique_name: default routing_target: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa task_queue_entered_date: 1634845217 age_in_queue: 0 addons: '{}' url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites/KGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites?PageSize=50&Page=0 next_page_url: null key: invites headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannelInvite /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_participant pathType: list post: description: Add a Participant to a Channel. summary: Add a Participant to a Channel. tags: - FlexV1InteractionChannelParticipant parameters: - name: InteractionSid in: path description: The Interaction Sid for the new Channel Participant. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for the new Channel Participant. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' examples: create: value: sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer routing_properties: task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reservation_sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInteractionChannelParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateInteractionChannelParticipantRequest properties: Type: $ref: '#/components/schemas/interaction_channel_participant_enum_type' MediaProperties: description: JSON representing the Media Properties for the new Participant. RoutingProperties: description: Object representing the Routing Properties for the new Participant. required: - Type - MediaProperties examples: create: value: Type: customer MediaProperties: '{"level": "to", "name": "Random Person test", "address":"random@person.com", "type": "email"}' RoutingProperties: '{"task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}' get: description: List all Participants for a Channel. summary: List all Participants for a Channel. tags: - FlexV1InteractionChannelParticipant parameters: - name: InteractionSid in: path description: The Interaction Sid for this channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for this Participant. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: participants: type: array items: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListInteractionChannelParticipantResponse examples: read: value: participants: - sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: customer routing_properties: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 - sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: agent routing_properties: task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reservation_sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2 meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0 next_page_url: null key: participants headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListInteractionChannelParticipant /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_channel_participant pathType: instance post: description: Update an existing Channel Participant. summary: Update an existing Channel Participant. tags: - FlexV1InteractionChannelParticipant parameters: - name: InteractionSid in: path description: The Interaction Sid for this channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for this Participant. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string created by Twilio to identify an Interaction Channel resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant' examples: update: value: sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: agent routing_properties: task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reservation_sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 updateStatusClosed: value: sid: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: agent routing_properties: task_sid: WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa worker_sid: WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa reservation_sid: WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInteractionChannelParticipant requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateInteractionChannelParticipantRequest properties: Status: $ref: '#/components/schemas/interaction_channel_participant_enum_status' required: - Status examples: update: value: Status: closed updateStatusClosed: value: Status: closed /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Transfers: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_transfer pathType: list post: description: Create a new Transfer. summary: Create a new Transfer. tags: - FlexV1InteractionTransfer parameters: - name: InteractionSid in: path description: The Interaction Sid for the Interaction schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for the Channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_transfer' examples: create: value: sid: UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: QWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: cold status: completed from: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa note_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa summary_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transfers/UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab date_created: '2022-01-10T20:00:00Z' date_updated: '2022-01-10T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateInteractionTransfer requestBody: content: application/json: schema: type: object title: CreateInteractionTransferRequest properties: {} /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Transfers/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid parent: /Interactions/{InteractionSid}/Channels/{Sid} className: interaction_transfer pathType: instance get: description: Fetch a specific Transfer by SID. summary: Fetch a specific Transfer by SID. tags: - FlexV1InteractionTransfer parameters: - name: InteractionSid in: path description: The Interaction Sid for this channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for this Transfer. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string created by Twilio to identify a Transfer resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_transfer' examples: fetch: value: sid: UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: QWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: cold status: completed from: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa note_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa summary_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transfers/UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2022-01-10T20:00:00Z' date_updated: '2022-01-10T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchInteractionTransfer post: description: Update an existing Transfer. summary: Update an existing Transfer. tags: - FlexV1InteractionTransfer parameters: - name: InteractionSid in: path description: The Interaction Sid for this channel. schema: type: string minLength: 34 maxLength: 34 pattern: ^KD[0-9a-fA-F]{32}$ required: true - name: ChannelSid in: path description: The Channel Sid for this Transfer. schema: type: string minLength: 34 maxLength: 34 pattern: ^UO[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The unique string created by Twilio to identify a Transfer resource. schema: type: string minLength: 34 maxLength: 34 pattern: ^UX[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.interaction.interaction_channel.interaction_transfer' examples: update: value: sid: UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa instance_sid: GOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa interaction_sid: KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_sid: UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: QWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: cold status: completed from: UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa to: WWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa note_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa summary_sid: KQaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transfers/UXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2022-01-10T20:00:00Z' date_updated: '2022-01-10T20:00:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateInteractionTransfer requestBody: content: application/json: schema: type: object title: UpdateInteractionTransferRequest properties: {} /v1/PluginService/Plugins: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name dependentProperties: plugin_versions: mapping: plugin_sid: sid resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions pathType: list get: description: '' summary: '' tags: - FlexV1Plugin parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: plugins: type: array items: $ref: '#/components/schemas/flex.v1.plugin' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPluginResponse examples: readEmpty: value: plugins: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0 next_page_url: null key: plugins readFull: value: plugins: - sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique-name friendly_name: friendly name description: description archived: false date_created: '2020-01-10T20:00:00Z' date_updated: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugin_versions: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0 next_page_url: null key: plugins headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPlugin post: description: '' summary: '' tags: - FlexV1Plugin parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin' examples: create: value: sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique-name friendly_name: friendly name description: description archived: false date_created: '2020-01-10T20:00:00Z' date_updated: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugin_versions: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreatePlugin requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePluginRequest properties: UniqueName: type: string description: The Flex Plugin's unique name. FriendlyName: type: string description: The Flex Plugin's friendly name. Description: type: string description: A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long required: - UniqueName examples: create: value: UniqueName: unique-name FriendlyName: friendly name Description: description /v1/PluginService/Plugins/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name dependentProperties: plugin_versions: mapping: plugin_sid: sid resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions pathType: instance get: description: '' summary: '' tags: - FlexV1Plugin parameters: - name: Sid in: path description: The SID of the Flex Plugin resource to fetch. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin' examples: fetch: value: sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique-name friendly_name: friendly name description: description archived: false date_created: '2020-01-10T20:00:00Z' date_updated: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugin_versions: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPlugin post: description: '' summary: '' tags: - FlexV1Plugin parameters: - name: Sid in: path description: The SID of the Flex Plugin resource to update. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin' examples: update: value: sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique-name friendly_name: friendly name update description: description update archived: false date_created: '2020-01-10T20:00:00Z' date_updated: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugin_versions: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdatePlugin requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdatePluginRequest properties: FriendlyName: type: string description: The Flex Plugin's friendly name. Description: type: string description: A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long examples: update: value: FriendlyName: friendly name update Description: description update /v1/PluginService/Plugins/{Sid}/Archive: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name mountName: plugin_archive pathType: instance post: description: '' summary: '' tags: - FlexV1PluginArchive parameters: - name: Sid in: path description: The SID of the Flex Plugin resource to archive. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_archive' examples: updateArchive: value: sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa unique_name: unique-name friendly_name: friendly name update description: description update archived: true date_created: '2020-01-10T20:00:00Z' date_updated: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdatePluginArchive /v1/PluginService/Configurations: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - name - description dependentProperties: plugins: mapping: configuration_sid: sid resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins mountName: plugin_configurations pathType: list get: description: '' summary: '' tags: - FlexV1PluginConfiguration parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: configurations: type: array items: $ref: '#/components/schemas/flex.v1.plugin_configuration' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPluginConfigurationResponse examples: readEmpty: value: configurations: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0 next_page_url: null key: configurations readFull: value: configurations: - sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: some name description: description archived: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugins: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0 next_page_url: null key: configurations headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPluginConfiguration post: description: '' summary: '' tags: - FlexV1PluginConfiguration parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_configuration' examples: create: value: sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: some name description: description archived: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugins: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreatePluginConfiguration requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePluginConfigurationRequest properties: Name: type: string description: The Flex Plugin Configuration's name. Plugins: type: array items: {} description: A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version. Description: type: string description: The Flex Plugin Configuration's description. required: - Name examples: create: value: Name: some name Description: description Plugins: - '{"plugin_version": "FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "phase": 3}' /v1/PluginService/Configurations/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - name - description dependentProperties: plugins: mapping: configuration_sid: sid resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins mountName: plugin_configurations pathType: instance get: description: '' summary: '' tags: - FlexV1PluginConfiguration parameters: - name: Sid in: path description: The SID of the Flex Plugin Configuration resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_configuration' examples: fetch: value: sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: some name description: description archived: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: plugins: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPluginConfiguration /v1/PluginService/Configurations/{Sid}/Archive: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - name - description mountName: plugin_configuration_archive pathType: instance post: description: '' summary: '' tags: - FlexV1PluginConfigurationArchive parameters: - name: Sid in: path description: The SID of the Flex Plugin Configuration resource to archive. schema: type: string minLength: 34 maxLength: 34 pattern: ^FJ[0-9a-fA-F]{32}$ required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_configuration_archive' examples: updateArchive: value: sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: some name description: description archived: true date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdatePluginConfigurationArchive /v1/PluginService/Releases: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - configuration_sid - date_created mountName: plugin_releases pathType: list get: description: '' summary: '' tags: - FlexV1PluginRelease parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: releases: type: array items: $ref: '#/components/schemas/flex.v1.plugin_release' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPluginReleaseResponse examples: readEmpty: value: releases: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0 next_page_url: null key: releases readFull: value: releases: - sid: FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Releases?PageSize=50&Page=0 next_page_url: null key: releases headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPluginRelease post: description: '' summary: '' tags: - FlexV1PluginRelease parameters: - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_release' examples: create: value: sid: FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreatePluginRelease requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePluginReleaseRequest properties: ConfigurationId: type: string description: The SID or the Version of the Flex Plugin Configuration to release. required: - ConfigurationId examples: create: value: ConfigurationId: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa /v1/PluginService/Releases/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - configuration_sid - date_created mountName: plugin_releases pathType: instance get: description: '' summary: '' tags: - FlexV1PluginRelease parameters: - name: Sid in: path description: The SID of the Flex Plugin Release resource to fetch. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_release' examples: fetchActive: value: sid: FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetch: value: sid: FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa configuration_sid: FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Releases/FKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPluginRelease /v1/PluginService/Plugins/{PluginSid}/Versions: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - plugin_sid - version parent: /PluginService/Plugins/{Sid} mountName: plugin_versions className: plugin_versions pathType: list get: description: '' summary: '' tags: - FlexV1PluginVersions parameters: - name: PluginSid in: path description: The SID of the Flex Plugin the resource to belongs to. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: plugin_versions: type: array items: $ref: '#/components/schemas/flex.v1.plugin.plugin_version' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPluginVersionResponse examples: readEmpty: value: plugin_versions: [] meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0 next_page_url: null key: plugin_versions readFull: value: plugin_versions: - sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: false archived: false validated: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions?PageSize=50&Page=0 next_page_url: null key: plugin_versions headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPluginVersion post: description: '' summary: '' tags: - FlexV1PluginVersions parameters: - name: PluginSid in: path description: The SID of the Flex Plugin the resource to belongs to. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin.plugin_version' examples: create: value: sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: true archived: false validated: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCliVersion: value: sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: true archived: false validated: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCliAndValidateStatus: value: sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: true archived: false validated: true date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreatePluginVersion requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePluginVersionRequest properties: Version: type: string description: The Flex Plugin Version's version. PluginUrl: type: string format: uri description: The URL of the Flex Plugin Version bundle Changelog: type: string description: The changelog of the Flex Plugin Version. Private: type: boolean description: Whether this Flex Plugin Version requires authorization. CliVersion: type: string description: The version of Flex Plugins CLI used to create this plugin ValidateStatus: type: string description: The validation status of the plugin, indicating whether it has been validated required: - Version - PluginUrl examples: create: value: Version: 1.0.0 PluginUrl: https://sample.twil.io/plugin.js Changelog: the changelog Private: true createWithCliVersion: value: Version: 1.0.0 PluginUrl: https://sample.twil.io/plugin.js Changelog: the changelog Private: true CliVersion: 6.3.2 createWithCliAndValidateStatus: value: Version: 1.0.0 PluginUrl: https://sample.twil.io/plugin.js Changelog: the changelog Private: true CliVersion: 6.3.2 ValidateStatus: success /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - plugin_sid - version parent: /PluginService/Plugins/{Sid} mountName: plugin_versions className: plugin_versions pathType: instance get: description: '' summary: '' tags: - FlexV1PluginVersions parameters: - name: PluginSid in: path description: The SID of the Flex Plugin the resource to belongs to. schema: type: string required: true - name: Sid in: path description: The SID of the Flex Plugin Version resource to fetch. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin.plugin_version' examples: fetch: value: sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: false archived: false validated: false date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPluginVersion /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - plugin_sid - version mountName: plugin_version_archive pathType: instance post: description: '' summary: '' tags: - FlexV1PluginVersionArchive parameters: - name: PluginSid in: path description: The SID of the Flex Plugin the resource to belongs to. schema: type: string required: true - name: Sid in: path description: The SID of the Flex Plugin Version resource to archive. schema: type: string required: true - name: Flex-Metadata in: header description: The Flex-Metadata HTTP request header schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.plugin_version_archive' examples: updateArchive: value: sid: FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa plugin_sid: FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa version: 1.0.0 plugin_url: https://sample.twil.io/plugin.js changelog: the changelog private: false archived: true date_created: '2020-01-10T20:00:00Z' url: https://flex-api.twilio.com/v1/PluginService/Plugins/FPaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Versions/FVaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Archive headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdatePluginVersionArchive /v1/account/provision/status: servers: - url: https://flex-api.twilio.com description: Status for email provisioning x-twilio: defaultOutputProperties: - status mountName: provisioning_status pathType: instance get: description: '' summary: '' tags: - FlexV1ProvisioningStatus responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.provisioning_status' examples: fetch: value: status: active url: https://flex-api.twilio.com/v1/account/provision/status headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchProvisioningStatus /v1/WebChannels: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid mountName: web_channel pathType: list get: description: '' summary: '' tags: - FlexV1WebChannel parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: flex_chat_channels: type: array items: $ref: '#/components/schemas/flex.v1.web_channel' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListWebChannelResponse examples: readFull: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 next_page_url: null key: flex_chat_channels flex_chat_channels: - flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa readEmpty: value: meta: page: 0 page_size: 50 first_page_url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 previous_page_url: null url: https://flex-api.twilio.com/v1/WebChannels?PageSize=50&Page=0 next_page_url: null key: flex_chat_channels flex_chat_channels: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListWebChannel post: description: '' summary: '' tags: - FlexV1WebChannel responses: '201': content: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' examples: create: value: flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateWebChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateWebChannelRequest properties: FlexFlowSid: type: string minLength: 34 maxLength: 34 pattern: ^FO[0-9a-fA-F]{32}$ description: The SID of the Flex Flow. Identity: type: string description: The chat identity. CustomerFriendlyName: type: string description: The chat participant's friendly name. ChatFriendlyName: type: string description: The chat channel's friendly name. ChatUniqueName: type: string description: The chat channel's unique name. PreEngagementData: type: string description: The pre-engagement data. required: - FlexFlowSid - Identity - CustomerFriendlyName - ChatFriendlyName examples: create: value: FlexFlowSid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Identity: abc ChatFriendlyName: firendly1 CustomerFriendlyName: friendly2 PreEngagementData: '{}' /v1/WebChannels/{Sid}: servers: - url: https://flex-api.twilio.com description: '' x-twilio: defaultOutputProperties: - sid - flex_flow_sid mountName: web_channel pathType: instance get: description: '' summary: '' tags: - FlexV1WebChannel parameters: - name: Sid in: path description: The SID of the WebChannel resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' examples: fetch: value: flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchWebChannel post: description: '' summary: '' tags: - FlexV1WebChannel parameters: - name: Sid in: path description: The SID of the WebChannel resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/flex.v1.web_channel' examples: update: value: flex_flow_sid: FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2016-08-01T22:10:40Z' date_updated: '2016-08-01T22:10:40Z' url: https://flex-api.twilio.com/v1/WebChannels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateWebChannel requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateWebChannelRequest properties: ChatStatus: $ref: '#/components/schemas/web_channel_enum_chat_status' PostEngagementData: type: string description: The post-engagement data. examples: update: value: ChatStatus: inactive PostEngagementData: '{}' delete: description: '' summary: '' tags: - FlexV1WebChannel parameters: - name: Sid in: path description: The SID of the WebChannel resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^CH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteWebChannel servers: - url: https://flex-api.twilio.com tags: - name: FlexV1AiInsights - name: FlexV1AiInsightsConversations - name: FlexV1AiInsightsConversationsExportData - name: FlexV1Assessments - name: FlexV1Channel - name: FlexV1ChannelParticipantTwiml - name: FlexV1ChannelUser - name: FlexV1Configuration - name: FlexV1ConfiguredPlugin - name: FlexV1FlexFlow - name: FlexV1FlexTeam - name: FlexV1FlexTeamContext - name: FlexV1FlexTeamMembers - name: FlexV1FlexTeamOwners - name: FlexV1FlexTokenInfo - name: FlexV1FlexUser - name: FlexV1FlexVideoOrchestration - name: FlexV1Index - name: FlexV1InsightsAssessmentsComment - name: FlexV1InsightsConversationalAi - name: FlexV1InsightsConversations - name: FlexV1InsightsQuestionnaires - name: FlexV1InsightsQuestionnairesCategory - name: FlexV1InsightsQuestionnairesQuestion - name: FlexV1InsightsSegments - name: FlexV1InsightsSession - name: FlexV1InsightsSettingsAnswerSets - name: FlexV1InsightsSettingsComment - name: FlexV1InsightsUserRoles - name: FlexV1Interaction - name: FlexV1InteractionChannel - name: FlexV1InteractionChannelApp - name: FlexV1InteractionChannelInvite - name: FlexV1InteractionChannelParticipant - name: FlexV1InteractionContext - name: FlexV1InteractionContextLookup - name: FlexV1InteractionContextLookupId - name: FlexV1InteractionContextLookupSid - name: FlexV1InteractionContextUpdate - name: FlexV1InteractionTransfer - name: FlexV1InteractionWebhooks - name: FlexV1LibraryPlugin - name: FlexV1LibraryPluginDetail - name: FlexV1LibraryPluginVariable - name: FlexV1LibraryPluginVariableUpdate - name: FlexV1LibraryPluginsUpdate - name: FlexV1Plugin - name: FlexV1PluginArchive - name: FlexV1PluginConfiguration - name: FlexV1PluginConfigurationArchive - name: FlexV1PluginRelease - name: FlexV1PluginVersionArchive - name: FlexV1PluginVersions - name: FlexV1ProvisioningStatus - name: FlexV1PublicConfiguration - name: FlexV1SalesforceCloudVoiceCallRecords - name: FlexV1SalesforceCloudVoiceCallRecordsOmniflow - name: FlexV1SalesforceCloudVoiceCallRecordsUpdate - name: FlexV1SalesforceCloudVoiceCertificate - name: FlexV1Transfer - name: FlexV1Version - name: FlexV1VirtualAgentData - name: FlexV1WebChannel security: - accountSid_authToken: []