Skip to contentSkip to navigationSkip to topbar
Rate this page:

Studio Flow and Widget JSON Schemas


Official JSON Schemas(link takes you to an external page) for Studio Flow definitions and widgets are available in the list below. Flow definitions must adhere to these schemas when creating or updating via the Flows REST API.

These schemas can be used for reference or for client-side validation in your local development environment. For sample Flow definitions to use in your applications, use the JSON snippets from Studio Flow Definition.

Flow Definition Schema

flow-definition-schema page anchor

_389
{
_389
"$schema": "http://json-schema.org/draft-07/schema#",
_389
"$id": "https://schemas.twilio.com/studio/draft/2019-09/flow-definition",
_389
"title": "Definition schema for twilio studio flow ",
_389
"type": "object",
_389
"definitions": {
_389
"Flags": {
_389
"type": "object",
_389
"properties": {
_389
"allow_concurrent_calls": {
_389
"type": "boolean"
_389
}
_389
},
_389
"required": [
_389
"allow_concurrent_calls"
_389
]
_389
}
_389
},
_389
"properties": {
_389
"description": {
_389
"type": "string"
_389
},
_389
"$schema": {
_389
"type": "string",
_389
"enum": [
_389
"https://schemas.twilio.com/studio/draft/2019-09/flow-definition"
_389
],
_389
"default": "https://schemas.twilio.com/studio/draft/2019-09/flow-definition"
_389
},
_389
"flags": {
_389
"$ref": "#/definitions/Flags"
_389
},
_389
"initial_state": {
_389
"type": "string",
_389
"minLength": 1
_389
},
_389
"states": {
_389
"type": "array",
_389
"additionalItems": false,
_389
"minItems": 1,
_389
"maxItems": 1000,
_389
"items": {
_389
"properties": {
_389
"type": {
_389
"type": "string",
_389
"enum": [
_389
"add-member-to-chat-channel",
_389
"add-twiml-redirect",
_389
"capture-payments",
_389
"connect-call-to",
_389
"create-chat-channel",
_389
"create-task",
_389
"enqueue-call",
_389
"fork-stream",
_389
"gather-input-on-call",
_389
"make-http-request",
_389
"make-outgoing-call-v1",
_389
"make-outgoing-call-v2",
_389
"record-call",
_389
"record-voicemail",
_389
"run-function",
_389
"say-play",
_389
"send-and-wait-for-reply",
_389
"send-message",
_389
"send-to-auto-pilot",
_389
"send-to-flex",
_389
"set-variables",
_389
"split-based-on",
_389
"trigger",
_389
"understand",
_389
"update-sync-object"
_389
]
_389
}
_389
},
_389
"required": [
_389
"type"
_389
],
_389
"allOf": [
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "add-member-to-chat-channel"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/add-member-to-chat-channel"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "send-to-auto-pilot"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/send-to-auto-pilot"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "connect-call-to"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/connect-call-to"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "create-chat-channel"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/create-chat-channel"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "create-task"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/create-task"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "make-outgoing-call-v1"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/2/make-outgoing-call-v1"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "make-outgoing-call-v2"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/2/make-outgoing-call-v2"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "enqueue-call"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/enqueue-call"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "fork-stream"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/fork-stream"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "gather-input-on-call"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/gather-input-on-call"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "make-http-request"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/make-http-request"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "capture-payments"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/capture-payments"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "record-call"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/record-call"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "record-voicemail"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/record-voicemail"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "add-twiml-redirect"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/add-twiml-redirect"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "run-function"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/run-function"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "say-play"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/say-play"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "send-and-wait-for-reply"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/send-and-wait-for-reply"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "send-message"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/send-message"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "send-to-flex"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/send-to-flex"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "set-variables"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/set-variables"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "split-based-on"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/split-based-on"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "trigger"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/trigger"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "understand"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/understand"
_389
}
_389
},
_389
{
_389
"if": {
_389
"properties": {
_389
"type": {
_389
"const": "update-sync-object"
_389
}
_389
}
_389
},
_389
"then": {
_389
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/update-sync-object"
_389
}
_389
}
_389
]
_389
}
_389
}
_389
},
_389
"required": [
_389
"description",
_389
"initial_state",
_389
"states"
_389
],
_389
"schema_revision": 1
_389
}


_105
{
_105
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_105
"$id": "https://schemas.twilio.com/studio/draft/2019-09/trigger",
_105
"title": "Trigger",
_105
"description": "The trigger widget",
_105
"definitions": {
_105
"IncomingCall": {
_105
"type": "object",
_105
"title": "Incoming Call",
_105
"allOf": [
_105
{
_105
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_105
},
_105
{
_105
"properties": {
_105
"event": {
_105
"type": "string",
_105
"const": "incomingCall"
_105
}
_105
},
_105
"required": [
_105
"event"
_105
]
_105
}
_105
]
_105
},
_105
"IncomingMessage": {
_105
"type": "object",
_105
"title": "Incoming Message (SMS or Chat)",
_105
"allOf": [
_105
{
_105
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_105
},
_105
{
_105
"properties": {
_105
"event": {
_105
"type": "string",
_105
"const": "incomingMessage"
_105
}
_105
},
_105
"required": [
_105
"event"
_105
]
_105
}
_105
]
_105
},
_105
"IncomingRequest": {
_105
"type": "object",
_105
"title": "REST API",
_105
"allOf": [
_105
{
_105
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_105
},
_105
{
_105
"properties": {
_105
"event": {
_105
"type": "string",
_105
"const": "incomingRequest"
_105
}
_105
},
_105
"required": [
_105
"event"
_105
]
_105
}
_105
]
_105
}
_105
},
_105
"type": "object",
_105
"properties": {
_105
"type": {
_105
"type": "string",
_105
"const": "trigger"
_105
},
_105
"name": {
_105
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_105
},
_105
"transitions": {
_105
"type": "array",
_105
"additionalItems": false,
_105
"minLength": 1,
_105
"items": {
_105
"anyOf": [
_105
{
_105
"$ref": "#/definitions/IncomingCall"
_105
},
_105
{
_105
"$ref": "#/definitions/IncomingMessage"
_105
},
_105
{
_105
"$ref": "#/definitions/IncomingRequest"
_105
}
_105
]
_105
}
_105
},
_105
"properties": {
_105
"type": "object"
_105
}
_105
},
_105
"required": [
_105
"type",
_105
"transitions"
_105
],
_105
"maturity": "ga",
_105
"schema_revision": 1
_105
}

Add TwiML Redirect Schema

add-twiml-redirect-schema page anchor

_94
{
_94
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_94
"$id": "https://schemas.twilio.com/studio/draft/2019-09/add-twiml-redirect",
_94
"type": "object",
_94
"title": "Add Twiml Redirect",
_94
"definitions": {
_94
"Return": {
_94
"type": "object",
_94
"title": "Fail",
_94
"allOf": [
_94
{
_94
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_94
},
_94
{
_94
"properties": {
_94
"event": {
_94
"type": "string",
_94
"const": "return"
_94
}
_94
}
_94
}
_94
]
_94
},
_94
"Fail": {
_94
"type": "object",
_94
"title": "Fail",
_94
"allOf": [
_94
{
_94
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_94
},
_94
{
_94
"properties": {
_94
"event": {
_94
"type": "string",
_94
"const": "fail"
_94
}
_94
}
_94
}
_94
]
_94
}
_94
},
_94
"properties": {
_94
"type": {
_94
"type": "string",
_94
"const": "add-twiml-redirect"
_94
},
_94
"name": {
_94
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_94
},
_94
"properties": {
_94
"type": "object",
_94
"properties": {
_94
"url": {
_94
"type": "string",
_94
"minLength": 1
_94
},
_94
"method": {
_94
"type": "string",
_94
"default": "POST"
_94
},
_94
"timeout": {
_94
"type": "string",
_94
"default": 14400
_94
}
_94
},
_94
"required": [
_94
"url"
_94
]
_94
},
_94
"transitions": {
_94
"type": "array",
_94
"additionalItems": false,
_94
"items": {
_94
"anyOf": [
_94
{
_94
"$ref": "#/definitions/Return"
_94
},
_94
{
_94
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Timeout"
_94
},
_94
{
_94
"$ref": "#/definitions/Fail"
_94
}
_94
]
_94
}
_94
}
_94
},
_94
"required": [
_94
"properties",
_94
"transitions"
_94
],
_94
"maturity": "ga",
_94
"schema_revision": 1
_94
}


_216
{
_216
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_216
"$id": "https://schemas.twilio.com/studio/draft/2019-09/capture-payments",
_216
"type": "object",
_216
"title": "Capture Payments",
_216
"definitions": {
_216
"MaxFailedAttempts": {
_216
"type": "object",
_216
"allOf": [
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_216
},
_216
{
_216
"properties": {
_216
"event": {
_216
"type": "string",
_216
"const": "maxFailedAttempts"
_216
}
_216
}
_216
}
_216
]
_216
},
_216
"ProviderError": {
_216
"type": "object",
_216
"allOf": [
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_216
},
_216
{
_216
"properties": {
_216
"event": {
_216
"type": "string",
_216
"const": "providerError"
_216
}
_216
}
_216
}
_216
]
_216
},
_216
"ValidationError": {
_216
"type": "object",
_216
"allOf": [
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_216
},
_216
{
_216
"properties": {
_216
"event": {
_216
"type": "string",
_216
"const": "validationError"
_216
}
_216
}
_216
}
_216
]
_216
},
_216
"PayInterrupted": {
_216
"type": "object",
_216
"allOf": [
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_216
},
_216
{
_216
"properties": {
_216
"event": {
_216
"type": "string",
_216
"const": "payInterrupted"
_216
}
_216
}
_216
}
_216
]
_216
}
_216
},
_216
"properties": {
_216
"type": {
_216
"type": "string",
_216
"const": "capture-payments"
_216
},
_216
"name": {
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_216
},
_216
"properties": {
_216
"type": "object",
_216
"properties": {
_216
"timeout": {
_216
"type": "integer",
_216
"minimum": 1,
_216
"maximum": 30,
_216
"default": 5
_216
},
_216
"max_attempts": {
_216
"type": "integer",
_216
"minimum": 1,
_216
"maximum": 3,
_216
"default": 2
_216
},
_216
"security_code": {
_216
"type": "boolean"
_216
},
_216
"postal_code": {
_216
"type": "string"
_216
},
_216
"payment_connector": {
_216
"type": "string"
_216
},
_216
"payment_token_type": {
_216
"type": "string",
_216
"enum": [
_216
"one-time",
_216
"reusable"
_216
],
_216
"default": "reusable"
_216
},
_216
"payment_amount": {
_216
"type": "string"
_216
},
_216
"currency": {
_216
"type": "string",
_216
"enum": [
_216
"eur",
_216
"gbp",
_216
"usd"
_216
],
_216
"default": "usd"
_216
},
_216
"description": {
_216
"type": "string"
_216
},
_216
"valid_card_types": {
_216
"type": "array",
_216
"additionalItems": false,
_216
"items": {
_216
"anyOf": [
_216
{
_216
"type": "string",
_216
"enum": [
_216
"amex",
_216
"diners-club",
_216
"discover",
_216
"enroute",
_216
"jcb",
_216
"maestro",
_216
"master-card",
_216
"mastercard",
_216
"optima",
_216
"visa"
_216
]
_216
}
_216
]
_216
}
_216
},
_216
"language": {
_216
"type": "string"
_216
},
_216
"min_postal_code_length": {
_216
"type": "integer"
_216
},
_216
"payment_method": {
_216
"type": "string",
_216
"enum": [
_216
"ACH_DEBIT",
_216
"CREDIT_CARD"
_216
]
_216
},
_216
"bank_account_type": {
_216
"type": "string",
_216
"enum": [
_216
"COMMERCIAL_CHECKING",
_216
"COMMERCIAL_SAVINGS",
_216
"CONSUMER_CHECKING",
_216
"CONSUMER_SAVINGS"
_216
]
_216
},
_216
"parameters": {
_216
"type": "array",
_216
"additionalItems": false,
_216
"items": {
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Parameter"
_216
}
_216
}
_216
}
_216
},
_216
"transitions": {
_216
"type": "array",
_216
"additionalItems": false,
_216
"items": {
_216
"anyOf": [
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Hangup"
_216
},
_216
{
_216
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Success"
_216
},
_216
{
_216
"$ref": "#/definitions/MaxFailedAttempts"
_216
},
_216
{
_216
"$ref": "#/definitions/ProviderError"
_216
},
_216
{
_216
"$ref": "#/definitions/ValidationError"
_216
},
_216
{
_216
"$ref": "#/definitions/PayInterrupted"
_216
}
_216
]
_216
}
_216
}
_216
},
_216
"required": [
_216
"type",
_216
"name",
_216
"properties",
_216
"transitions"
_216
],
_216
"maturity": "ga",
_216
"schema_revision": 1
_216
}


_113
{
_113
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_113
"$id": "https://schemas.twilio.com/studio/draft/2019-09/connect-call-to",
_113
"type": "object",
_113
"title": "Connect Call To",
_113
"definitions": {
_113
"CallEnded": {
_113
"type": "object",
_113
"title": "Connected Call Ended",
_113
"allOf": [
_113
{
_113
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_113
},
_113
{
_113
"properties": {
_113
"event": {
_113
"type": "string",
_113
"const": "callCompleted"
_113
}
_113
}
_113
}
_113
]
_113
},
_113
"Hangup": {
_113
"type": "object",
_113
"title": "Caller Hung up",
_113
"allOf": [
_113
{
_113
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_113
},
_113
{
_113
"properties": {
_113
"event": {
_113
"type": "string",
_113
"const": "hangup"
_113
}
_113
}
_113
}
_113
]
_113
}
_113
},
_113
"properties": {
_113
"type": {
_113
"type": "string",
_113
"const": "connect-call-to"
_113
},
_113
"name": {
_113
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_113
},
_113
"properties": {
_113
"type": "object",
_113
"properties": {
_113
"to": {
_113
"type": "string"
_113
},
_113
"caller_id": {
_113
"type": "string"
_113
},
_113
"record": {
_113
"type": "boolean"
_113
},
_113
"noun": {
_113
"type": "string",
_113
"enum": [
_113
"client",
_113
"conference",
_113
"number",
_113
"number-multi",
_113
"sim",
_113
"sip"
_113
]
_113
},
_113
"sip_endpoint": {
_113
"type": "string"
_113
},
_113
"sip_username": {
_113
"type": "string"
_113
},
_113
"sip_password": {
_113
"type": "string"
_113
},
_113
"timeout": {
_113
"type": "integer"
_113
}
_113
},
_113
"required": [
_113
"noun"
_113
]
_113
},
_113
"transitions": {
_113
"type": "array",
_113
"additionalItems": false,
_113
"items": {
_113
"anyOf": [
_113
{
_113
"$ref": "#/definitions/CallEnded"
_113
},
_113
{
_113
"$ref": "#/definitions/Hangup"
_113
}
_113
]
_113
}
_113
}
_113
},
_113
"required": [
_113
"type",
_113
"name",
_113
"properties",
_113
"transitions"
_113
],
_113
"maturity": "ga",
_113
"schema_revision": 1
_113
}


_102
{
_102
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_102
"$id": "https://schemas.twilio.com/studio/draft/2019-09/enqueue-call",
_102
"title": "Enqueue Call",
_102
"type": "object",
_102
"definitions": {
_102
"FailedToEnqueue": {
_102
"type": "object",
_102
"title": "Failed to Enqueue",
_102
"allOf": [
_102
{
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_102
},
_102
{
_102
"properties": {
_102
"event": {
_102
"type": "string",
_102
"const": "failedToEnqueue"
_102
}
_102
}
_102
}
_102
]
_102
},
_102
"CallFailure": {
_102
"type": "object",
_102
"title": "Call Failed",
_102
"allOf": [
_102
{
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_102
},
_102
{
_102
"properties": {
_102
"event": {
_102
"type": "string",
_102
"const": "callFailure"
_102
}
_102
}
_102
}
_102
]
_102
}
_102
},
_102
"properties": {
_102
"type": {
_102
"type": "string",
_102
"const": "enqueue-call"
_102
},
_102
"name": {
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_102
},
_102
"properties": {
_102
"type": "object",
_102
"properties": {
_102
"workflow_sid": {
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WorkflowSid"
_102
},
_102
"queue_name": {
_102
"type": "string"
_102
},
_102
"priority": {
_102
"type": "integer"
_102
},
_102
"timeout": {
_102
"type": "integer"
_102
},
_102
"task_attributes": {
_102
"type": "string"
_102
},
_102
"wait_url": {
_102
"type": "string"
_102
},
_102
"wait_url_method": {
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/HttpMethod"
_102
}
_102
}
_102
},
_102
"transitions": {
_102
"type": "array",
_102
"additionalItems": false,
_102
"items": {
_102
"anyOf": [
_102
{
_102
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/CallComplete"
_102
},
_102
{
_102
"$ref": "#/definitions/FailedToEnqueue"
_102
},
_102
{
_102
"$ref": "#/definitions/CallFailure"
_102
}
_102
]
_102
}
_102
}
_102
},
_102
"required": [
_102
"type",
_102
"name",
_102
"properties",
_102
"transitions"
_102
],
_102
"maturity": "ga",
_102
"schema_revision": 1
_102
}


_109
{
_109
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_109
"$id": "https://schemas.twilio.com/studio/draft/2019-09/fork-stream",
_109
"type": "object",
_109
"title": "Fork Stream",
_109
"properties": {
_109
"type": {
_109
"type": "string",
_109
"const": "fork-stream"
_109
},
_109
"name": {
_109
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_109
},
_109
"properties": {
_109
"type": "object",
_109
"properties": {
_109
"stream_action": {
_109
"type": "string",
_109
"enum": [
_109
"start",
_109
"stop"
_109
],
_109
"default": "start"
_109
},
_109
"stream_name": {
_109
"type": "string"
_109
},
_109
"stream_transport_type": {
_109
"type": "string",
_109
"enum": [
_109
"spirec",
_109
"websocket"
_109
],
_109
"default": "webSocket"
_109
},
_109
"stream_connector": {
_109
"type": "string"
_109
},
_109
"stream_url": {
_109
"type": "string"
_109
},
_109
"stream_track": {
_109
"type": "string",
_109
"enum": [
_109
"both_track",
_109
"inbound_track",
_109
"outbound_track"
_109
],
_109
"default": "inbound_track"
_109
},
_109
"stream_parameters": {
_109
"type": "array",
_109
"additionalItems": false,
_109
"items": {
_109
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Parameter"
_109
}
_109
}
_109
},
_109
"transitions": {
_109
"type": "array",
_109
"additionalItems": false,
_109
"items": {
_109
"type": "object",
_109
"allOf": [
_109
{
_109
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_109
},
_109
{
_109
"properties": {
_109
"event": {
_109
"type": "string",
_109
"const": "next"
_109
}
_109
}
_109
}
_109
]
_109
}
_109
}
_109
},
_109
"transitions": {
_109
"type": "array",
_109
"additionalItems": false,
_109
"items": {
_109
"type": "object",
_109
"allOf": [
_109
{
_109
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_109
},
_109
{
_109
"properties": {
_109
"event": {
_109
"type": "string",
_109
"const": "next"
_109
}
_109
}
_109
}
_109
]
_109
}
_109
}
_109
},
_109
"required": [
_109
"type",
_109
"name",
_109
"properties",
_109
"transitions"
_109
],
_109
"maturity": "ga",
_109
"schema_revision": 1
_109
}

Gather Input On Call Schema

gather-input-on-call-schema page anchor

_141
{
_141
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_141
"$id": "https://schemas.twilio.com/studio/draft/2019-09/gather-input-on-call",
_141
"type": "object",
_141
"title": "Gather Input On Call",
_141
"definitions": {
_141
"KeyPress": {
_141
"type": "object",
_141
"title": "User Pressed Keys",
_141
"allOf": [
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_141
},
_141
{
_141
"properties": {
_141
"event": {
_141
"type": "string",
_141
"const": "keypress"
_141
}
_141
}
_141
}
_141
]
_141
},
_141
"Speech": {
_141
"type": "object",
_141
"title": "User Said Something",
_141
"allOf": [
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_141
},
_141
{
_141
"properties": {
_141
"event": {
_141
"type": "string",
_141
"const": "speech"
_141
}
_141
}
_141
}
_141
]
_141
}
_141
},
_141
"properties": {
_141
"type": {
_141
"type": "string",
_141
"const": "gather-input-on-call"
_141
},
_141
"name": {
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_141
},
_141
"properties": {
_141
"type": "object",
_141
"properties": {
_141
"timeout": {
_141
"type": "integer"
_141
},
_141
"finish_on_key": {
_141
"type": "string"
_141
},
_141
"stop_gather": {
_141
"type": "boolean"
_141
},
_141
"number_of_digits": {
_141
"type": "integer"
_141
},
_141
"save_response_as": {
_141
"type": "string"
_141
},
_141
"say": {
_141
"type": "string"
_141
},
_141
"play": {
_141
"type": "string"
_141
},
_141
"voice": {
_141
"type": "string"
_141
},
_141
"language": {
_141
"type": "string"
_141
},
_141
"loop": {
_141
"type": "integer"
_141
},
_141
"hints": {
_141
"type": "string"
_141
},
_141
"gather_language": {
_141
"type": "string"
_141
},
_141
"speech_timeout": {
_141
"type": "string"
_141
},
_141
"speech_model": {
_141
"type": "string"
_141
},
_141
"profanity_filter": {
_141
"type": "string"
_141
}
_141
},
_141
"oneOf": [
_141
{
_141
"required": [
_141
"say"
_141
]
_141
},
_141
{
_141
"required": [
_141
"play"
_141
]
_141
}
_141
]
_141
},
_141
"transitions": {
_141
"type": "array",
_141
"additionalItems": false,
_141
"items": {
_141
"anyOf": [
_141
{
_141
"$ref": "#/definitions/KeyPress"
_141
},
_141
{
_141
"$ref": "#/definitions/Speech"
_141
},
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Timeout"
_141
},
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Hangup"
_141
}
_141
]
_141
}
_141
}
_141
},
_141
"required": [
_141
"type",
_141
"name",
_141
"properties",
_141
"transitions"
_141
],
_141
"maturity": "ga",
_141
"schema_revision": 1
_141
}

Make HTTP Request Schema

make-http-request-schema page anchor

_66
{
_66
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_66
"$id": "https://schemas.twilio.com/studio/draft/2019-09/make-http-request",
_66
"title": "Make HTTP Request",
_66
"type": "object",
_66
"properties": {
_66
"type": {
_66
"type": "string",
_66
"const": "make-http-request"
_66
},
_66
"name": {
_66
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_66
},
_66
"properties": {
_66
"type": "object",
_66
"properties": {
_66
"method": {
_66
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/HttpMethod",
_66
"default": "GET"
_66
},
_66
"url": {
_66
"type": "string",
_66
"minLength": 1
_66
},
_66
"body": {
_66
"type": "string"
_66
},
_66
"parameters": {
_66
"type": "array",
_66
"additionalItems": false,
_66
"items": {
_66
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Parameter"
_66
}
_66
},
_66
"content_type": {
_66
"type": "string",
_66
"default": "application/x-www-form-urlencoded"
_66
}
_66
},
_66
"required": [
_66
"url"
_66
]
_66
},
_66
"transitions": {
_66
"type": "array",
_66
"additionalItems": false,
_66
"items": {
_66
"anyOf": [
_66
{
_66
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Success"
_66
},
_66
{
_66
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Failed"
_66
}
_66
]
_66
}
_66
}
_66
},
_66
"required": [
_66
"type",
_66
"name",
_66
"properties",
_66
"transitions"
_66
],
_66
"maturity": "ga"
_66
}

Make Outgoing Call v1 Schema (Deprecated)

make-outgoing-call-v1-schema-deprecated page anchor

_154
{
_154
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_154
"$id": "https://schemas.twilio.com/studio/draft/2019-09/2/make-outgoing-call-v1",
_154
"title": "Make Outgoing Call",
_154
"type": "object",
_154
"definitions": {
_154
"AnsweredByMachine": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "answeredByMachine"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"Answered": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "answered"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"Busy": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "busy"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"NoAnswer": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "noAnswer"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"Hangup": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "hangup"
_154
}
_154
}
_154
}
_154
]
_154
}
_154
},
_154
"properties": {
_154
"type": {
_154
"type": "string",
_154
"const": "make-outgoing-call-v1"
_154
},
_154
"name": {
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_154
},
_154
"properties": {
_154
"type": "object",
_154
"properties": {
_154
"from": {
_154
"type": "string",
_154
"title": "Number to make call from",
_154
"default": "{{contact.channel.address}}"
_154
},
_154
"to": {
_154
"type": "string",
_154
"title": "Number to call",
_154
"default": "{{flow.channel.address}}"
_154
},
_154
"record": {
_154
"type": "boolean"
_154
},
_154
"timeout": {
_154
"type": "integer"
_154
}
_154
},
_154
"required": [
_154
"from",
_154
"to"
_154
]
_154
},
_154
"transitions": {
_154
"type": "array",
_154
"additionalItems": false,
_154
"items": {
_154
"anyOf": [
_154
{
_154
"$ref": "#/definitions/Answered"
_154
},
_154
{
_154
"$ref": "#/definitions/Busy"
_154
},
_154
{
_154
"$ref": "#/definitions/NoAnswer"
_154
},
_154
{
_154
"$ref": "#/definitions/AnsweredByMachine"
_154
},
_154
{
_154
"$ref": "#/definitions/Hangup"
_154
},
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Failed"
_154
}
_154
]
_154
}
_154
}
_154
},
_154
"required": [
_154
"properties",
_154
"transitions"
_154
],
_154
"maturity": "ga",
_154
"schema_revision": 1
_154
}

Make Outgoing Call v2 Schema

make-outgoing-call-v2-schema page anchor

_154
{
_154
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_154
"$id": "https://schemas.twilio.com/studio/draft/2019-09/2/make-outgoing-call-v2",
_154
"title": "Make Outgoing Call",
_154
"type": "object",
_154
"definitions": {
_154
"Answered": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "answered"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"Busy": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "busy"
_154
}
_154
}
_154
}
_154
]
_154
},
_154
"NoAnswer": {
_154
"type": "object",
_154
"allOf": [
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_154
},
_154
{
_154
"properties": {
_154
"event": {
_154
"type": "string",
_154
"const": "noAnswer"
_154
}
_154
}
_154
}
_154
]
_154
}
_154
},
_154
"properties": {
_154
"type": {
_154
"type": "string",
_154
"const": "make-outgoing-call-v2"
_154
},
_154
"name": {
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_154
},
_154
"properties": {
_154
"type": "object",
_154
"properties": {
_154
"from": {
_154
"type": "string",
_154
"title": "Number to make call from",
_154
"default": "{{contact.channel.address}}"
_154
},
_154
"to": {
_154
"type": "string",
_154
"title": "Number to call",
_154
"default": "{{flow.channel.address}}"
_154
},
_154
"record": {
_154
"type": "boolean"
_154
},
_154
"recording_channels": {
_154
"type": "string"
_154
},
_154
"recording_status_callback": {
_154
"type": "string"
_154
},
_154
"trim": {
_154
"type": "string"
_154
},
_154
"detect_answering_machine": {
_154
"type": "boolean"
_154
},
_154
"machine_detection": {
_154
"type": "string"
_154
},
_154
"machine_detection_timeout": {
_154
"type": "string"
_154
},
_154
"machine_detection_speech_threshold": {
_154
"type": "string"
_154
},
_154
"machine_detection_speech_end_threshold": {
_154
"type": "string"
_154
},
_154
"machine_detection_silence_timeout": {
_154
"type": "string"
_154
},
_154
"send_digits": {
_154
"type": "string"
_154
},
_154
"timeout": {
_154
"type": "integer",
_154
"minimum": 0,
_154
"maximum": 60
_154
},
_154
"sip_auth_username": {
_154
"type": "string"
_154
},
_154
"sip_auth_password": {
_154
"type": "string"
_154
}
_154
},
_154
"required": [
_154
"from",
_154
"to"
_154
]
_154
},
_154
"transitions": {
_154
"type": "array",
_154
"additionalItems": false,
_154
"items": {
_154
"anyOf": [
_154
{
_154
"$ref": "#/definitions/Answered"
_154
},
_154
{
_154
"$ref": "#/definitions/Busy"
_154
},
_154
{
_154
"$ref": "#/definitions/NoAnswer"
_154
},
_154
{
_154
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Failed"
_154
}
_154
]
_154
}
_154
}
_154
},
_154
"required": [
_154
"properties",
_154
"transitions"
_154
],
_154
"maturity": "ga",
_154
"schema_revision": 1
_154
}


_58
{
_58
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_58
"$id": "https://schemas.twilio.com/studio/draft/2019-09/record-call",
_58
"type": "object",
_58
"title": "Record Call",
_58
"properties": {
_58
"type": {
_58
"type": "string",
_58
"const": "record-call"
_58
},
_58
"name": {
_58
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_58
},
_58
"properties": {
_58
"type": "object",
_58
"properties": {
_58
"record_call": {
_58
"type": "boolean"
_58
},
_58
"recording_status_callback": {
_58
"type": "string"
_58
},
_58
"recording_status_callback_method": {
_58
"type": "string"
_58
},
_58
"recording_status_callback_events": {
_58
"type": "string"
_58
},
_58
"recording_channels": {
_58
"type": "string"
_58
},
_58
"trim": {
_58
"type": "string"
_58
}
_58
}
_58
},
_58
"transitions": {
_58
"type": "array",
_58
"additionalItems": false,
_58
"items": {
_58
"anyOf": [
_58
{
_58
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Success"
_58
},
_58
{
_58
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Failed"
_58
}
_58
]
_58
}
_58
}
_58
},
_58
"required": [
_58
"properties",
_58
"transitions"
_58
],
_58
"maturity": "ga",
_58
"schema_revision": 1
_58
}


_107
{
_107
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_107
"$id": "https://schemas.twilio.com/studio/draft/2019-09/record-voicemail",
_107
"type": "object",
_107
"title": "Record Voicemail",
_107
"definitions": {
_107
"RecordingComplete": {
_107
"type": "object",
_107
"title": "On Reply",
_107
"allOf": [
_107
{
_107
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_107
},
_107
{
_107
"properties": {
_107
"event": {
_107
"type": "string",
_107
"const": "recordingComplete"
_107
}
_107
}
_107
}
_107
]
_107
},
_107
"NoAudio": {
_107
"type": "object",
_107
"title": "On Reply",
_107
"allOf": [
_107
{
_107
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_107
},
_107
{
_107
"properties": {
_107
"event": {
_107
"type": "string",
_107
"const": "noAudio"
_107
}
_107
}
_107
}
_107
]
_107
}
_107
},
_107
"properties": {
_107
"type": {
_107
"type": "string",
_107
"const": "record-voicemail"
_107
},
_107
"name": {
_107
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_107
},
_107
"properties": {
_107
"type": "object",
_107
"properties": {
_107
"timeout": {
_107
"title": "Stop recording after (in seconds)",
_107
"type": "integer"
_107
},
_107
"finish_on_key": {
_107
"type": "string"
_107
},
_107
"max_length": {
_107
"type": "integer",
_107
"default": 3600
_107
},
_107
"transcribe": {
_107
"type": "boolean"
_107
},
_107
"transcription_callback_url": {
_107
"type": "string"
_107
},
_107
"trim": {
_107
"type": "string"
_107
},
_107
"play_beep": {
_107
"type": "string"
_107
},
_107
"recording_status_callback_url": {
_107
"type": "string"
_107
}
_107
}
_107
},
_107
"transitions": {
_107
"type": "array",
_107
"additionalItems": false,
_107
"items": {
_107
"anyOf": [
_107
{
_107
"$ref": "#/definitions/RecordingComplete"
_107
},
_107
{
_107
"$ref": "#/definitions/NoAudio"
_107
},
_107
{
_107
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Hangup"
_107
}
_107
]
_107
}
_107
}
_107
},
_107
"required": [
_107
"type",
_107
"name",
_107
"properties",
_107
"transitions"
_107
],
_107
"maturity": "ga",
_107
"schema_revision": 1
_107
}


_73
{
_73
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_73
"$id": "https://schemas.twilio.com/studio/draft/2019-09/run-function",
_73
"type": "object",
_73
"title": "Run Function",
_73
"definitions": {
_73
"Fail": {
_73
"type": "object",
_73
"title": "Fail",
_73
"allOf": [
_73
{
_73
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_73
},
_73
{
_73
"properties": {
_73
"event": {
_73
"type": "string",
_73
"const": "fail"
_73
}
_73
}
_73
}
_73
]
_73
}
_73
},
_73
"properties": {
_73
"type": {
_73
"type": "string",
_73
"const": "run-function"
_73
},
_73
"name": {
_73
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_73
},
_73
"properties": {
_73
"type": "object",
_73
"properties": {
_73
"url": {
_73
"type": "string"
_73
},
_73
"parameters": {
_73
"type": "array",
_73
"minLength": 1,
_73
"items": {
_73
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Parameter"
_73
}
_73
}
_73
},
_73
"required": [
_73
"url"
_73
]
_73
},
_73
"transitions": {
_73
"type": "array",
_73
"items": {
_73
"anyOf": [
_73
{
_73
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Success"
_73
},
_73
{
_73
"$ref": "#/definitions/Fail"
_73
}
_73
]
_73
}
_73
}
_73
},
_73
"required": [
_73
"type",
_73
"name",
_73
"properties",
_73
"transitions"
_73
],
_73
"maturity": "ga",
_73
"schema_revision": 1
_73
}


_91
{
_91
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_91
"$id": "https://schemas.twilio.com/studio/draft/2019-09/say-play",
_91
"type": "object",
_91
"title": "Say Play",
_91
"definitions": {
_91
"AudioComplete": {
_91
"type": "object",
_91
"title": "Audio Complete",
_91
"allOf": [
_91
{
_91
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_91
},
_91
{
_91
"properties": {
_91
"event": {
_91
"type": "string",
_91
"const": "audioComplete"
_91
}
_91
}
_91
}
_91
]
_91
}
_91
},
_91
"properties": {
_91
"type": {
_91
"type": "string",
_91
"const": "say-play"
_91
},
_91
"name": {
_91
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_91
},
_91
"properties": {
_91
"type": "object",
_91
"properties": {
_91
"say": {
_91
"type": "string"
_91
},
_91
"play": {
_91
"type": "string"
_91
},
_91
"voice": {
_91
"type": "string"
_91
},
_91
"language": {
_91
"type": "string"
_91
},
_91
"loop": {
_91
"type": "integer"
_91
},
_91
"digits": {
_91
"type": "string"
_91
}
_91
},
_91
"oneOf": [
_91
{
_91
"required": [
_91
"say"
_91
]
_91
},
_91
{
_91
"required": [
_91
"play"
_91
]
_91
}
_91
]
_91
},
_91
"transitions": {
_91
"type": "array",
_91
"additionalItems": false,
_91
"items": {
_91
"anyOf": [
_91
{
_91
"$ref": "#/definitions/AudioComplete"
_91
},
_91
{
_91
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Hangup"
_91
}
_91
]
_91
}
_91
}
_91
},
_91
"required": [
_91
"type",
_91
"name",
_91
"properties",
_91
"transitions"
_91
],
_91
"maturity": "ga",
_91
"schema_revision": 1
_91
}

Send & Wait For Reply Schema

send--wait-for-reply-schema page anchor

_134
{
_134
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_134
"$id": "https://schemas.twilio.com/studio/draft/2019-09/send-and-wait-for-reply",
_134
"title": "Send and wait for reply",
_134
"type": "object",
_134
"definitions": {
_134
"Reply": {
_134
"type": "object",
_134
"title": "On Reply",
_134
"allOf": [
_134
{
_134
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_134
},
_134
{
_134
"properties": {
_134
"event": {
_134
"type": "string",
_134
"const": "incomingMessage"
_134
}
_134
}
_134
}
_134
]
_134
},
_134
"NoReply": {
_134
"type": "object",
_134
"title": "Failed to Send",
_134
"allOf": [
_134
{
_134
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_134
},
_134
{
_134
"properties": {
_134
"event": {
_134
"type": "string",
_134
"const": "timeout"
_134
}
_134
}
_134
}
_134
]
_134
},
_134
"DeliveryFails": {
_134
"type": "object",
_134
"title": "Failed to Send",
_134
"allOf": [
_134
{
_134
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_134
},
_134
{
_134
"properties": {
_134
"event": {
_134
"type": "string",
_134
"const": "deliveryFailure"
_134
}
_134
}
_134
}
_134
]
_134
}
_134
},
_134
"properties": {
_134
"type": {
_134
"type": "string",
_134
"const": "send-and-wait-for-reply"
_134
},
_134
"name": {
_134
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_134
},
_134
"properties": {
_134
"type": "object",
_134
"properties": {
_134
"body": {
_134
"type": "string"
_134
},
_134
"from": {
_134
"type": "string",
_134
"default": "{{flow.channel.address}}"
_134
},
_134
"timeout": {
_134
"type": "integer",
_134
"default": 3600
_134
},
_134
"save_response_as": {
_134
"type": "string"
_134
},
_134
"media_url": {
_134
"type": "string"
_134
},
_134
"service": {
_134
"title": "Programmable Chat Service",
_134
"type": "string",
_134
"default": "{{trigger.message.InstanceSid}}"
_134
},
_134
"channel": {
_134
"type": "string",
_134
"title": "Programmable Chat Channel",
_134
"default": "{{trigger.message.ChannelSid}}"
_134
},
_134
"attributes": {
_134
"type": "string",
_134
"title": "Message Attributes"
_134
}
_134
},
_134
"required": [
_134
"body",
_134
"from"
_134
]
_134
},
_134
"transitions": {
_134
"type": "array",
_134
"additionalItems": false,
_134
"minItems": 1,
_134
"items": {
_134
"oneOf": [
_134
{
_134
"$ref": "#/definitions/Reply"
_134
},
_134
{
_134
"$ref": "#/definitions/NoReply"
_134
},
_134
{
_134
"$ref": "#/definitions/DeliveryFails"
_134
}
_134
]
_134
}
_134
}
_134
},
_134
"required": [
_134
"type",
_134
"name",
_134
"properties",
_134
"transitions"
_134
],
_134
"maturity": "ga",
_134
"schema_revision": 1
_134
}


_110
{
_110
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_110
"$id": "https://schemas.twilio.com/studio/draft/2019-09/send-message",
_110
"type": "object",
_110
"title": "Send Message",
_110
"definitions": {
_110
"Sent": {
_110
"type": "object",
_110
"title": "Message Sent",
_110
"allOf": [
_110
{
_110
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_110
},
_110
{
_110
"properties": {
_110
"event": {
_110
"type": "string",
_110
"const": "sent"
_110
}
_110
}
_110
}
_110
]
_110
},
_110
"Failed": {
_110
"type": "object",
_110
"title": "Failed to Send",
_110
"allOf": [
_110
{
_110
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_110
},
_110
{
_110
"properties": {
_110
"event": {
_110
"type": "string",
_110
"const": "failed"
_110
}
_110
}
_110
}
_110
]
_110
}
_110
},
_110
"properties": {
_110
"type": {
_110
"type": "string",
_110
"const": "send-message"
_110
},
_110
"name": {
_110
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_110
},
_110
"properties": {
_110
"type": "object",
_110
"properties": {
_110
"body": {
_110
"type": "string"
_110
},
_110
"from": {
_110
"type": "string",
_110
"default": "{{flow.channel.address}}"
_110
},
_110
"to": {
_110
"type": "string",
_110
"default": "{{contact.channel.address}}"
_110
},
_110
"media_url": {
_110
"type": "string"
_110
},
_110
"service": {
_110
"title": "Programmable Chat Service",
_110
"type": "string",
_110
"default": "{{trigger.message.InstanceSid}}"
_110
},
_110
"channel": {
_110
"type": "string",
_110
"title": "Programmable Chat Channel",
_110
"default": "{{trigger.message.ChannelSid}}"
_110
},
_110
"attributes": {
_110
"type": "string",
_110
"title": "Message Attributes"
_110
}
_110
},
_110
"required": [
_110
"body",
_110
"from"
_110
]
_110
},
_110
"transitions": {
_110
"type": "array",
_110
"additionalItems": false,
_110
"items": {
_110
"anyOf": [
_110
{
_110
"$ref": "#/definitions/Sent"
_110
},
_110
{
_110
"$ref": "#/definitions/Failed"
_110
}
_110
]
_110
}
_110
}
_110
},
_110
"required": [
_110
"type",
_110
"name",
_110
"properties",
_110
"transitions"
_110
],
_110
"maturity": "ga",
_110
"schema_revision": 1
_110
}

Send to Autopilot Schema

send-to-autopilot-schema page anchor

_141
{
_141
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_141
"$id": "https://schemas.twilio.com/studio/draft/2019-09/send-to-auto-pilot",
_141
"type": "object",
_141
"title": "Send To Autopilot",
_141
"description": "Sends the interaction to auto pilot widget",
_141
"definitions": {
_141
"SessionEnded": {
_141
"type": "object",
_141
"title": "Session Ended",
_141
"allOf": [
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_141
},
_141
{
_141
"properties": {
_141
"event": {
_141
"type": "string",
_141
"const": "sessionEnded"
_141
}
_141
}
_141
}
_141
]
_141
},
_141
"Failure": {
_141
"type": "object",
_141
"title": "Session Failed",
_141
"allOf": [
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_141
},
_141
{
_141
"properties": {
_141
"event": {
_141
"type": "string",
_141
"const": "failure"
_141
}
_141
}
_141
}
_141
]
_141
},
_141
"Timeout": {
_141
"type": "object",
_141
"title": "Timeout",
_141
"allOf": [
_141
{
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_141
},
_141
{
_141
"properties": {
_141
"event": {
_141
"type": "string",
_141
"const": "timeout"
_141
}
_141
}
_141
}
_141
]
_141
}
_141
},
_141
"properties": {
_141
"type": {
_141
"type": "string",
_141
"const": "send-to-auto-pilot"
_141
},
_141
"name": {
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_141
},
_141
"properties": {
_141
"type": "object",
_141
"properties": {
_141
"autopilot_assistant_sid": {
_141
"type": "string",
_141
"pattern": "^.*\\S+.*$",
_141
"minLength": 1
_141
},
_141
"model_sid": {
_141
"type": "string"
_141
},
_141
"from": {
_141
"type": "string"
_141
},
_141
"body": {
_141
"type": "string"
_141
},
_141
"chat_service": {
_141
"type": "string"
_141
},
_141
"chat_channel": {
_141
"type": "string"
_141
},
_141
"chat_attributes": {
_141
"type": "string"
_141
},
_141
"timeout": {
_141
"type": "integer"
_141
},
_141
"target_task": {
_141
"type": "string"
_141
},
_141
"memory_parameters": {
_141
"type": "array",
_141
"minLength": 1,
_141
"items": {
_141
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/Parameter"
_141
}
_141
}
_141
},
_141
"required": [
_141
"autopilot_assistant_sid",
_141
"from",
_141
"body",
_141
"timeout"
_141
]
_141
},
_141
"transitions": {
_141
"type": "array",
_141
"additionalItems": false,
_141
"items": {
_141
"anyOf": [
_141
{
_141
"$ref": "#/definitions/SessionEnded"
_141
},
_141
{
_141
"$ref": "#/definitions/Failure"
_141
},
_141
{
_141
"$ref": "#/definitions/Timeout"
_141
}
_141
]
_141
}
_141
}
_141
},
_141
"required": [
_141
"type",
_141
"name",
_141
"properties",
_141
"transitions"
_141
],
_141
"maturity": "ga",
_141
"schema_revision": 1
_141
}


_115
{
_115
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_115
"$id": "https://schemas.twilio.com/studio/draft/2019-09/send-to-flex",
_115
"type": "object",
_115
"title": "Send To Flex",
_115
"description": "Sends the call or chat message to flex",
_115
"definitions": {
_115
"FailedToEnqueue": {
_115
"$id": "failedToEnqueue",
_115
"type": "object",
_115
"title": "Task Creation Failed",
_115
"allOf": [
_115
{
_115
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_115
},
_115
{
_115
"properties": {
_115
"event": {
_115
"type": "string",
_115
"const": "failedToEnqueue"
_115
}
_115
}
_115
}
_115
]
_115
},
_115
"CallFailure": {
_115
"$id": "CallFailure",
_115
"type": "object",
_115
"title": "Call Failed",
_115
"description": "Call failed to enqueue",
_115
"allOf": [
_115
{
_115
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_115
},
_115
{
_115
"properties": {
_115
"event": {
_115
"type": "string",
_115
"const": "callFailure"
_115
}
_115
}
_115
}
_115
]
_115
}
_115
},
_115
"properties": {
_115
"type": {
_115
"type": "string",
_115
"const": "send-to-flex"
_115
},
_115
"name": {
_115
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_115
},
_115
"properties": {
_115
"type": "object",
_115
"properties": {
_115
"workflow": {
_115
"type": "string",
_115
"pattern": "^.*\\S+.*$",
_115
"minLength": 1
_115
},
_115
"channel": {
_115
"type": "string",
_115
"pattern": "^.*\\S+.*$",
_115
"minLength": 1
_115
},
_115
"attributes": {
_115
"type": "string"
_115
},
_115
"timeout": {
_115
"type": "integer"
_115
},
_115
"priority": {
_115
"type": "string"
_115
},
_115
"waitUrl": {
_115
"type": "string"
_115
},
_115
"waitUrlMethod": {
_115
"type": "string"
_115
}
_115
},
_115
"required": [
_115
"workflow",
_115
"channel"
_115
]
_115
},
_115
"transitions": {
_115
"type": "array",
_115
"additionalItems": false,
_115
"minItems": 0,
_115
"items": {
_115
"anyOf": [
_115
{
_115
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/CallComplete"
_115
},
_115
{
_115
"$ref": "#/definitions/FailedToEnqueue"
_115
},
_115
{
_115
"$ref": "#/definitions/CallFailure"
_115
}
_115
]
_115
}
_115
}
_115
},
_115
"required": [
_115
"type",
_115
"name",
_115
"properties",
_115
"transitions"
_115
],
_115
"maturity": "ga",
_115
"schema_revision": 1
_115
}


_55
{
_55
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_55
"$id": "https://schemas.twilio.com/studio/draft/2019-09/set-variables",
_55
"type": "object",
_55
"title": "Set Variables",
_55
"properties": {
_55
"type": {
_55
"type": "string",
_55
"const": "set-variables"
_55
},
_55
"name": {
_55
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_55
},
_55
"properties": {
_55
"variables": {
_55
"type": "array",
_55
"additionalItems": false,
_55
"items": {
_55
"type": "object",
_55
"additionalProperties": {
_55
"type": "string"
_55
}
_55
}
_55
}
_55
},
_55
"transitions": {
_55
"type": "array",
_55
"additionalItems": false,
_55
"items": {
_55
"type": "object",
_55
"allOf": [
_55
{
_55
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/NextLink"
_55
},
_55
{
_55
"properties": {
_55
"event": {
_55
"type": "string",
_55
"const": "next"
_55
}
_55
}
_55
}
_55
]
_55
}
_55
}
_55
},
_55
"required": [
_55
"type",
_55
"name",
_55
"properties",
_55
"transitions"
_55
],
_55
"maturity": "ga",
_55
"schema_revision": 1
_55
}


_113
{
_113
"$schema": "https://schemas.twilio.com/studio/draft/2019-09/core#",
_113
"$id": "https://schemas.twilio.com/studio/draft/2019-09/split-based-on",
_113
"type": "object",
_113
"definitions": {
_113
"Condition": {
_113
"type": "object",
_113
"properties": {
_113
"friendly_name": {
_113
"type": "string",
_113
"minLength": 1
_113
},
_113
"type": {
_113
"type": "string",
_113
"enum": [
_113
"contains",
_113
"does_not_contain",
_113
"does_not_match_any_of",
_113
"does_not_start_with",
_113
"equal_to",
_113
"greater_than",
_113
"is_after_date",
_113
"is_after_time",
_113
"is_before_date",
_113
"is_before_time",
_113
"is_blank",
_113
"is_not_blank",
_113
"less_than",
_113
"matches_any_of",
_113
"not_equal_to",
_113
"regex",
_113
"starts_with"
_113
]
_113
},
_113
"arguments": {
_113
"type": "array",
_113
"additionalItems": false,
_113
"minItems": 1,
_113
"maxItems": 100,
_113
"items": {
_113
"type": "string"
_113
}
_113
},
_113
"value": {
_113
"type": "string",
_113
"minLength": 1
_113
}
_113
},
_113
"required": [
_113
"friendly_name",
_113
"type",
_113
"arguments",
_113
"value"
_113
]
_113
}
_113
},
_113
"properties": {
_113
"type": {
_113
"type": "string",
_113
"const": "split-based-on"
_113
},
_113
"name": {
_113
"$ref": "https://schemas.twilio.com/studio/draft/2019-09/commons#/definitions/WidgetName"
_113
},
_113
"properties": {
_113
"type": "object",
_113
"properties": {
_113
"input": {
_113
"title": "Variable to test",
_113
"type": "string",
_113
"minLength": 1
_113
}
_113
},
_113
"required": [
_113
"input"
_113
]
_113
},
_113
"transitions": {
_113
"type": "array",
_113
"additionalItems": false,
_113
"items": {
_113
"type": "object",
_113
"properties": {
_113
"event": {
_113
"type": "string",
_113
"enum": [
_113
"match",
_113
"noMatch"
_113
]
_113
},
_113
"next": {
_113
"type": "string"
_113
},
_113
"condition": {
_113
"type": "array",
_113
"additionalItems": false,
_113
"items": {
_113
"$ref": "#/definitions/Condition"
_113
}
_113
}
_113
}
_113
}
_113
}
_113
},
_113
"required": [
_113
"type",
_113
"name",
_113
"properties",
_113
"transitions"
_113
],
_113
"maturity": "ga",
_113
"schema_revision": 1
_113
}


Rate this page: