components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: studio.v1.flow.engagement: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Engagement 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 Engagement resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. contact_sid: type: string minLength: 34 maxLength: 34 pattern: ^FC[0-9a-fA-F]{32}$ nullable: true description: The SID of the Contact. contact_channel_address: type: string nullable: true description: The phone number, SIP address or Client identifier that triggered this Engagement. Phone numbers are in E.164 format (+16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. context: nullable: true description: The current state of the execution flow. As your flow executes, we save the state in a flow context. Your widgets can access the data in the flow context as variables, either in configuration fields or in text areas as variable substitution. status: $ref: '#/components/schemas/engagement_enum_status' date_created: type: string format: date-time nullable: true description: The date and time in GMT when the Engagement was created 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 Engagement was updated in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of the Engagement's nested resources. engagement_enum_status: type: string enum: - active - ended description: 'The status of the Engagement. Can be: `active` or `ended`.' studio.v1.flow.engagement.engagement_context: 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. context: nullable: true description: As your flow executes, we save the state in what's called the Flow Context. Any data in the flow context can be accessed by your widgets as variables, either in configuration fields or in text areas as variable substitution. engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Engagement. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. url: type: string format: uri nullable: true description: The URL of the resource. studio.v1.flow.execution: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Execution 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 Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. contact_sid: type: string minLength: 34 maxLength: 34 pattern: ^FC[0-9a-fA-F]{32}$ nullable: true description: The SID of the Contact. contact_channel_address: type: string nullable: true description: The phone number, SIP address or Client identifier that triggered the Execution. Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. x-twilio: pii: handling: standard deleteSla: 30 context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 status: $ref: '#/components/schemas/execution_enum_status' 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. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of nested resources. execution_enum_status: type: string enum: - active - ended description: 'The status of the Execution. Can be: `active` or `ended`.' studio.v1.flow.execution.execution_context: 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 ExecutionContext resource. context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the context's Execution resource. url: type: string format: uri nullable: true description: The absolute URL of the resource. studio.v1.flow.execution.execution_step: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ExecutionStep 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 ExecutionStep resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Step's Execution resource. parent_step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: This field shows the Step SID of the Widget in the parent Flow that started the Subflow. If this Step is not part of a Subflow execution, the value is null. name: type: string nullable: true description: The event that caused the Flow to transition to the Step. context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 transitioned_from: type: string nullable: true description: The Widget that preceded the Widget for the Step. transitioned_to: type: string nullable: true description: The Widget that will follow the Widget for the Step. 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. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. studio.v1.flow.execution.execution_step.execution_step_context: 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 ExecutionStepContext resource. context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 execution_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the context's Execution resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: The SID of the Step that the context is associated with. url: type: string format: uri nullable: true description: The absolute URL of the resource. studio.v1.flow: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Flow 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 Flow resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the Flow. status: $ref: '#/components/schemas/flow_enum_status' version: type: integer default: 0 description: The latest version number of the Flow's definition. 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. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of the Flow's nested resources. flow_enum_status: type: string enum: - draft - published description: 'The status of the Flow. Can be: `draft` or `published`.' studio.v1.flow.engagement.step: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Step 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 Step resource. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Engagement. name: type: string nullable: true description: The event that caused the Flow to transition to the Step. context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 parent_step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: The SID of the parent Step. transitioned_from: type: string nullable: true description: The Widget that preceded the Widget for the Step. transitioned_to: type: string nullable: true description: The Widget that will follow the Widget for the Step. 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. url: type: string format: uri nullable: true description: The absolute URL of the resource. links: type: object format: uri-map nullable: true description: The URLs of related resources. studio.v1.flow.engagement.step.step_context: 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 StepContext resource. context: nullable: true description: The current state of the Flow's Execution. As a flow executes, we save its state in this context. We save data that your widgets can access as variables in configuration fields or in text areas as variable substitution. x-twilio: pii: handling: standard deleteSla: 30 engagement_sid: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Engagement. flow_sid: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ nullable: true description: The SID of the Flow. step_sid: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ nullable: true description: The SID of the Step the context is associated with. url: type: string format: uri nullable: true description: The absolute URL of the resource. info: title: Twilio - Studio 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/Flows/{FlowSid}/Engagements: servers: - url: https://studio.twilio.com description: '[DEPRECATED] Excecutions of Studio flows' x-twilio: defaultOutputProperties: - sid - contact_sid - status - date_created dependentProperties: steps: mapping: flow_sid: flow_sid engagement_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps engagement_context: mapping: flow_sid: flow_sid engagement_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} pathType: list get: description: Retrieve a list of all Engagements for the Flow. summary: Retrieve a list of all Engagements for the Flow. tags: - StudioV1Engagement parameters: - name: FlowSid in: path description: The SID of the Flow to read Engagements from. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[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: engagements: type: array items: $ref: '#/components/schemas/studio.v1.flow.engagement' 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: ListEngagementResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 page: 0 first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements?PageSize=50&Page=0 page_size: 50 key: engagements engagements: [] 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: ListEngagement post: description: Triggers a new Engagement for the Flow summary: Triggers a new Engagement for the Flow tags: - StudioV1Engagement parameters: - name: FlowSid in: path description: The SID of the Flow. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' examples: create: value: url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: {} contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_channel_address: '+18001234567' status: active date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' links: steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: CreateEngagement requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateEngagementRequest properties: To: type: string format: phone-number description: The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`. From: type: string format: phone-number description: The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}` Parameters: description: 'A JSON string we will add to your flow''s context and that you can access as variables inside your flow. For example, if you pass in `Parameters={''name'':''Zeke''}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string ''Zeke''. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.' required: - To - From examples: create: value: To: '+18001234567' From: '+18007654321' Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Engagements/{Sid}: servers: - url: https://studio.twilio.com description: '[DEPRECATED] Excecutions of Studio flows' x-twilio: defaultOutputProperties: - sid - contact_sid - status - date_created dependentProperties: steps: mapping: flow_sid: flow_sid engagement_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps engagement_context: mapping: flow_sid: flow_sid engagement_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Context parent: /Flows/{Sid} pathType: instance get: description: Retrieve an Engagement summary: Retrieve an Engagement tags: - StudioV1Engagement parameters: - name: FlowSid in: path description: The SID of the Flow. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Engagement resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement' examples: fetch: value: sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_channel_address: '+14155555555' status: ended context: {} date_created: '2017-11-06T12:00:00Z' date_updated: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps engagement_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchEngagement delete: description: Delete this Engagement and all Steps relating to it. summary: Delete this Engagement and all Steps relating to it. tags: - StudioV1Engagement parameters: - name: FlowSid in: path description: The SID of the Flow to delete Engagements from. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Engagement resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteEngagement /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Context: servers: - url: https://studio.twilio.com description: '[DEPRECATED] JSON context for engagements' x-twilio: defaultOutputProperties: - context parent: /Flows/{FlowSid}/Engagements/{Sid} mountName: engagement_context pathType: instance get: description: Retrieve the most recent context for an Engagement. summary: Retrieve the most recent context for an Engagement. tags: - StudioV1EngagementContext parameters: - name: FlowSid in: path description: The SID of the Flow. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: EngagementSid in: path description: The SID of the Engagement. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.engagement_context' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: foo: bar flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchEngagementContext /v1/Flows/{FlowSid}/Executions: servers: - url: https://studio.twilio.com description: Executions of Studio flows x-twilio: defaultOutputProperties: - sid - contact_sid - status - date_created dependentProperties: steps: mapping: flow_sid: flow_sid execution_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps execution_context: mapping: flow_sid: flow_sid execution_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: list get: description: Retrieve a list of all Executions for the Flow. summary: Retrieve a list of all Executions for the Flow. tags: - StudioV1Execution parameters: - name: FlowSid in: path description: The SID of the Flow with the Execution resources to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: DateCreatedFrom in: query description: Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. schema: type: string format: date-time - name: DateCreatedTo in: query description: Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`. schema: type: string format: date-time - 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: executions: type: array items: $ref: '#/components/schemas/studio.v1.flow.execution' 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: ListExecutionResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 page: 0 first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions?PageSize=50&Page=0 page_size: 50 key: executions executions: [] 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: ListExecution post: description: Triggers a new Execution for the Flow summary: Triggers a new Execution for the Flow tags: - StudioV1Execution parameters: - name: FlowSid in: path description: The SID of the Excecution's Flow. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' examples: create: value: url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: {} contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_channel_address: '+18001234567' status: active date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' links: steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: CreateExecution requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateExecutionRequest properties: To: type: string format: phone-number description: The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`. From: type: string format: phone-number description: The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`. For SMS, this can also be a Messaging Service SID. Parameters: description: 'JSON data that will be added to the Flow''s context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={"name":"Zeke"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns "Zeke". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.' required: - To - From examples: create: value: To: '+18001234567' From: '+18007654321' Parameters: '{"first_name":"Foo"}' /v1/Flows/{FlowSid}/Executions/{Sid}: servers: - url: https://studio.twilio.com description: Executions of Studio flows x-twilio: defaultOutputProperties: - sid - contact_sid - status - date_created dependentProperties: steps: mapping: flow_sid: flow_sid execution_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps execution_context: mapping: flow_sid: flow_sid execution_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Context parent: /Flows/{Sid} pathType: instance get: description: Retrieve an Execution summary: Retrieve an Execution tags: - StudioV1Execution parameters: - name: FlowSid in: path description: The SID of the Flow with the Execution resource to fetch schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Execution resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' examples: fetch: value: sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_channel_address: '+14155555555' status: ended context: {} date_created: '2017-11-06T12:00:00Z' date_updated: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchExecution delete: description: Delete the Execution and all Steps relating to it. summary: Delete the Execution and all Steps relating to it. tags: - StudioV1Execution parameters: - name: FlowSid in: path description: The SID of the Flow with the Execution resources to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Execution resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteExecution post: description: Update the status of an Execution to `ended`. summary: Update the status of an Execution to `ended`. tags: - StudioV1Execution parameters: - name: FlowSid in: path description: The SID of the Flow with the Execution resources to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Execution resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution' examples: update: value: url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: {} contact_sid: FCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa contact_channel_address: '+14155555555' status: ended date_created: '2017-11-06T12:00:00Z' date_updated: '2017-11-06T12:00:00Z' links: steps: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps execution_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: UpdateExecution requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateExecutionRequest properties: Status: $ref: '#/components/schemas/execution_enum_status' required: - Status examples: update: value: Status: ended /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Context: servers: - url: https://studio.twilio.com description: JSON context for executions x-twilio: defaultOutputProperties: - context parent: /Flows/{FlowSid}/Executions/{Sid} mountName: execution_context pathType: instance get: description: Retrieve the most recent context for an Execution. summary: Retrieve the most recent context for an Execution. tags: - StudioV1ExecutionContext parameters: - name: FlowSid in: path description: The SID of the Flow with the Execution context to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: ExecutionSid in: path description: The SID of the Execution context to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_context' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: foo: bar flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchExecutionContext /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps: servers: - url: https://studio.twilio.com description: Individual steps within an execution x-twilio: defaultOutputProperties: - sid - name - date_created dependentProperties: step_context: mapping: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: list get: description: Retrieve a list of all Steps for an Execution. summary: Retrieve a list of all Steps for an Execution. tags: - StudioV1ExecutionStep parameters: - name: FlowSid in: path description: The SID of the Flow with the Steps to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: ExecutionSid in: path description: The SID of the Execution with the Steps to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[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: steps: type: array items: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' 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: ListExecutionStepResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 page: 0 first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 page_size: 50 key: steps steps: [] 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: ListExecutionStep /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com description: Individual steps within an execution x-twilio: defaultOutputProperties: - sid - name - date_created dependentProperties: step_context: mapping: flow_sid: flow_sid execution_sid: execution_sid step_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions/{execution_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Executions/{Sid} className: execution_step pathType: instance get: description: Retrieve a Step. summary: Retrieve a Step. tags: - StudioV1ExecutionStep parameters: - name: FlowSid in: path description: The SID of the Flow with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: ExecutionSid in: path description: The SID of the Execution resource with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ExecutionStep resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step' examples: fetch: value: sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: incomingRequest context: {} parent_step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa transitioned_from: Trigger transitioned_to: Ended date_created: '2017-11-06T12:00:00Z' date_updated: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchExecutionStep /v1/Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com description: JSON context for an individual step within an execution x-twilio: defaultOutputProperties: - context parent: /Flows/{FlowSid}/Executions/{ExecutionSid}/Steps/{Sid} mountName: step_context className: execution_step_context pathType: instance get: description: Retrieve the context for an Execution Step. summary: Retrieve the context for an Execution Step. tags: - StudioV1ExecutionStepContext parameters: - name: FlowSid in: path description: The SID of the Flow with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: ExecutionSid in: path description: The SID of the Execution resource with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true - name: StepSid in: path description: The SID of the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: foo: bar flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa execution_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchExecutionStepContext /v1/Flows: servers: - url: https://studio.twilio.com description: Studio flows x-twilio: defaultOutputProperties: - sid - friendly_name - status - version dependentProperties: engagements: mapping: flow_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements executions: mapping: flow_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions pathType: list get: description: Retrieve a list of all Flows. summary: Retrieve a list of all Flows. tags: - StudioV1Flow 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: flows: type: array items: $ref: '#/components/schemas/studio.v1.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: ListFlowResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 page: 0 first_page_url: https://studio.twilio.com/v1/Flows?PageSize=50&Page=0 page_size: 50 key: flows 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: ListFlow /v1/Flows/{Sid}: servers: - url: https://studio.twilio.com description: Studio flows x-twilio: defaultOutputProperties: - sid - friendly_name - status - version dependentProperties: engagements: mapping: flow_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements executions: mapping: flow_sid: sid resource_url: /v1/Flows/{flow_sid}/Executions pathType: instance get: description: Retrieve a specific Flow. summary: Retrieve a specific Flow. tags: - StudioV1Flow parameters: - name: Sid in: path description: The SID of the Flow resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow' examples: fetch: value: sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: Test Flow status: published version: 1 date_created: '2017-11-06T12:00:00Z' date_updated: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: engagements: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements executions: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Executions 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: FetchFlow delete: description: Delete a specific Flow. summary: Delete a specific Flow. tags: - StudioV1Flow parameters: - name: Sid in: path description: The SID of the Flow resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteFlow /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps: servers: - url: https://studio.twilio.com description: Steps within a Studio flow x-twilio: defaultOutputProperties: - sid - name - transitioned_from - transitioned_to dependentProperties: step_context: mapping: flow_sid: flow_sid engagement_sid: engagement_sid step_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} pathType: list get: description: Retrieve a list of all Steps for an Engagement. summary: Retrieve a list of all Steps for an Engagement. tags: - StudioV1Step parameters: - name: FlowSid in: path description: The SID of the Flow with the Step to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: EngagementSid in: path description: The SID of the Engagement with the Step to read. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[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: steps: type: array items: $ref: '#/components/schemas/studio.v1.flow.engagement.step' 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: ListStepResponse examples: readEmpty: value: meta: previous_page_url: null next_page_url: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 page: 0 first_page_url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps?PageSize=50&Page=0 page_size: 50 key: steps steps: [] 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: ListStep /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid}: servers: - url: https://studio.twilio.com description: Steps within a Studio flow x-twilio: defaultOutputProperties: - sid - name - transitioned_from - transitioned_to dependentProperties: step_context: mapping: flow_sid: flow_sid engagement_sid: engagement_sid step_sid: sid resource_url: /v1/Flows/{flow_sid}/Engagements/{engagement_sid}/Steps/{step_sid}/Context parent: /Flows/{FlowSid}/Engagements/{Sid} pathType: instance get: description: Retrieve a Step. summary: Retrieve a Step. tags: - StudioV1Step parameters: - name: FlowSid in: path description: The SID of the Flow with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: EngagementSid in: path description: The SID of the Engagement with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Step resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step' examples: fetch: value: sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa name: incomingRequest context: {} parent_step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa transitioned_from: Trigger transitioned_to: Ended date_created: '2017-11-06T12:00:00Z' date_updated: null url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: step_context: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchStep /v1/Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{StepSid}/Context: servers: - url: https://studio.twilio.com description: JSON context for individual steps x-twilio: defaultOutputProperties: - context parent: /Flows/{FlowSid}/Engagements/{EngagementSid}/Steps/{Sid} mountName: step_context pathType: instance get: description: Retrieve the context for an Engagement Step. summary: Retrieve the context for an Engagement Step. tags: - StudioV1StepContext parameters: - name: FlowSid in: path description: The SID of the Flow with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ required: true - name: EngagementSid in: path description: The SID of the Engagement with the Step to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^FN[0-9a-fA-F]{32}$ required: true - name: StepSid in: path description: The SID of the Step to fetch schema: type: string minLength: 34 maxLength: 34 pattern: ^FT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/studio.v1.flow.engagement.step.step_context' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa context: foo: bar flow_sid: FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa engagement_sid: FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa step_sid: FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://studio.twilio.com/v1/Flows/FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Engagements/FNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Steps/FTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Context 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: FetchStepContext servers: - url: https://studio.twilio.com tags: - name: StudioV1Engagement - name: StudioV1EngagementContext - name: StudioV1Execution - name: StudioV1ExecutionContext - name: StudioV1ExecutionStep - name: StudioV1ExecutionStepContext - name: StudioV1Flow - name: StudioV1Index - name: StudioV1Step - name: StudioV1StepContext - name: StudioV1Version security: - accountSid_authToken: []