Twilio - Preview
This is the public Twilio REST API
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.1",
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"info": {
"contact": {
"email": "support@twilio.com",
"name": "Twilio Support",
"url": "https://support.twilio.com"
},
"description": "This is the public Twilio REST API.",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"termsOfService": "https://www.twilio.com/legal/tos",
"title": "Twilio - Preview",
"version": "1.42.0",
"x-apisguru-categories": [
"telecom",
"messaging"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_static1.twilio.com_marketing_bundles_marketing_img_logos_wordmark-red.svg"
},
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_preview.json",
"version": "3.0"
}
],
"x-providerName": "twilio.com",
"x-serviceName": "twilio_preview"
},
"paths": {
"/DeployedDevices/Fleets": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Fleets belonging to your account.",
"operationId": "ListDeployedDevicesFleet",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"fleets": {
"items": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet"
},
"type": "array"
},
"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": "ListDeployedDevicesFleetResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Create a new Fleet for scoping of deployed devices within your account.",
"operationId": "CreateDeployedDevicesFleet",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.",
"type": "string"
}
},
"title": "CreateDeployedDevicesFleetRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Certificates": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Certificate credentials belonging to the Fleet.",
"operationId": "ListDeployedDevicesCertificate",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.",
"in": "query",
"name": "DeviceSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"certificates": {
"items": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate"
},
"type": "array"
},
"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": "ListDeployedDevicesCertificateResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Enroll a new Certificate credential to the Fleet, optionally giving it a friendly name and assigning to a Device.",
"operationId": "CreateDeployedDevicesCertificate",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CertificateData": {
"description": "Provides a URL encoded representation of the public certificate in PEM format.",
"type": "string"
},
"DeviceSid": {
"description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.",
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.",
"type": "string"
}
},
"required": [
"CertificateData"
],
"title": "CreateDeployedDevicesCertificateRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "list"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}": {
"delete": {
"description": "Unregister a specific Certificate credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.",
"operationId": "DeleteDeployedDevicesCertificate",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^CY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch information about a specific Certificate credential in the Fleet.",
"operationId": "FetchDeployedDevicesCertificate",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^CY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update the given properties of a specific Certificate credential in the Fleet, giving it a friendly name or assigning to a Device.",
"operationId": "UpdateDeployedDevicesCertificate",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Certificate credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^CY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DeviceSid": {
"description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.",
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.",
"type": "string"
}
},
"title": "UpdateDeployedDevicesCertificateRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "instance"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Deployments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Deployments belonging to the Fleet.",
"operationId": "ListDeployedDevicesDeployment",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"deployments": {
"items": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment"
},
"type": "array"
},
"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": "ListDeployedDevicesDeploymentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Create a new Deployment in the Fleet, optionally giving it a friendly name and linking to a specific Twilio Sync service instance.",
"operationId": "CreateDeployedDevicesDeployment",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.",
"type": "string"
},
"SyncServiceSid": {
"description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.",
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
"title": "CreateDeployedDevicesDeploymentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "list"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Deployments/{Sid}": {
"delete": {
"description": "Delete a specific Deployment from the Fleet, leaving associated devices effectively undeployed.",
"operationId": "DeleteDeployedDevicesDeployment",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch information about a specific Deployment in the Fleet.",
"operationId": "FetchDeployedDevicesDeployment",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update the given properties of a specific Deployment credential in the Fleet, giving it a friendly name or linking to a specific Twilio Sync service instance.",
"operationId": "UpdateDeployedDevicesDeployment",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Deployment resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long",
"type": "string"
},
"SyncServiceSid": {
"description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.",
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
"title": "UpdateDeployedDevicesDeploymentRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "instance"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Devices": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Devices belonging to the Fleet.",
"operationId": "ListDeployedDevicesDevice",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.",
"in": "query",
"name": "DeploymentSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"devices": {
"items": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.device"
},
"type": "array"
},
"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": "ListDeployedDevicesDeviceResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Create a new Device in the Fleet, optionally giving it a unique name, friendly name, and assigning to a Deployment and/or human identity.",
"operationId": "CreateDeployedDevicesDevice",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DeploymentSid": {
"description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.",
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"Enabled": {
"description": "",
"type": "boolean"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.",
"type": "string"
},
"Identity": {
"description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.",
"type": "string"
},
"UniqueName": {
"description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long.",
"type": "string"
}
},
"title": "CreateDeployedDevicesDeviceRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.device"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "list"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Devices/{Sid}": {
"delete": {
"description": "Delete a specific Device from the Fleet, also removing it from associated Deployments.",
"operationId": "DeleteDeployedDevicesDevice",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Device resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch information about a specific Device in the Fleet.",
"operationId": "FetchDeployedDevicesDevice",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Device resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.device"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update the given properties of a specific Device in the Fleet, giving it a friendly name, assigning to a Deployment, or a human identity.",
"operationId": "UpdateDeployedDevicesDevice",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Device resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DeploymentSid": {
"description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.",
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"Enabled": {
"description": "",
"type": "boolean"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.",
"type": "string"
},
"Identity": {
"description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.",
"type": "string"
}
},
"title": "UpdateDeployedDevicesDeviceRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.device"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "instance"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Keys": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Keys credentials belonging to the Fleet.",
"operationId": "ListDeployedDevicesKey",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.",
"in": "query",
"name": "DeviceSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"keys": {
"items": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.key"
},
"type": "array"
},
"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": "ListDeployedDevicesKeyResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Create a new Key credential in the Fleet, optionally giving it a friendly name and assigning to a Device.",
"operationId": "CreateDeployedDevicesKey",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DeviceSid": {
"description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.",
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.",
"type": "string"
}
},
"title": "CreateDeployedDevicesKeyRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.key"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "list"
}
},
"/DeployedDevices/Fleets/{FleetSid}/Keys/{Sid}": {
"delete": {
"description": "Delete a specific Key credential from the Fleet, effectively disallowing any inbound client connections that are presenting it.",
"operationId": "DeleteDeployedDevicesKey",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^KY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch information about a specific Key credential in the Fleet.",
"operationId": "FetchDeployedDevicesKey",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^KY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.key"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update the given properties of a specific Key credential in the Fleet, giving it a friendly name or assigning to a Device.",
"operationId": "UpdateDeployedDevicesKey",
"parameters": [
{
"description": "",
"in": "path",
"name": "FleetSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Provides a 34 character string that uniquely identifies the requested Key credential resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^KY[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DeviceSid": {
"description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.",
"maxLength": 34,
"minLength": 34,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.",
"type": "string"
}
},
"title": "UpdateDeployedDevicesKeyRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet.key"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Fleets/{Sid}",
"pathType": "instance"
}
},
"/DeployedDevices/Fleets/{Sid}": {
"delete": {
"description": "Delete a specific Fleet from your account, also destroys all nested resources: Devices, Deployments, Certificates, Keys.",
"operationId": "DeleteDeployedDevicesFleet",
"parameters": [
{
"description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch information about a specific Fleet in your account.",
"operationId": "FetchDeployedDevicesFleet",
"parameters": [
{
"description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update the friendly name property of a specific Fleet in your account.",
"operationId": "UpdateDeployedDevicesFleet",
"parameters": [
{
"description": "Provides a 34 character string that uniquely identifies the requested Fleet resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"DefaultDeploymentSid": {
"description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.",
"maxLength": 34,
"minLength": 34,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"FriendlyName": {
"description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.",
"type": "string"
}
},
"title": "UpdateDeployedDevicesFleetRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.deployed_devices.fleet"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/HostedNumbers/AuthorizationDocuments": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.",
"operationId": "ListHostedNumbersAuthorizationDocument",
"parameters": [
{
"description": "Email that this AuthorizationDocument will be sent to for signing.",
"in": "query",
"name": "Email",
"schema": {
"type": "string"
}
},
{
"description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.",
"in": "query",
"name": "Status",
"schema": {
"$ref": "#/components/schemas/authorization_document_enum_status",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/preview.hosted_numbers.authorization_document"
},
"type": "array"
},
"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": "ListHostedNumbersAuthorizationDocumentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.",
"operationId": "CreateHostedNumbersAuthorizationDocument",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AddressSid": {
"description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.",
"maxLength": 34,
"minLength": 34,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"CcEmails": {
"description": "Email recipients who will be informed when an Authorization Document has been sent and signed.",
"items": {
"type": "string"
},
"type": "array"
},
"ContactPhoneNumber": {
"description": "The contact phone number of the person authorized to sign the Authorization Document.",
"type": "string"
},
"ContactTitle": {
"description": "The title of the person authorized to sign the Authorization Document for this phone number.",
"type": "string"
},
"Email": {
"description": "Email that this AuthorizationDocument will be sent to for signing.",
"type": "string"
},
"HostedNumberOrderSids": {
"description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"HostedNumberOrderSids",
"AddressSid",
"Email",
"ContactTitle",
"ContactPhoneNumber"
],
"title": "CreateHostedNumbersAuthorizationDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.authorization_document"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/HostedNumbers/AuthorizationDocuments/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific AuthorizationDocument.",
"operationId": "FetchHostedNumbersAuthorizationDocument",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this AuthorizationDocument.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.authorization_document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Updates a specific AuthorizationDocument.",
"operationId": "UpdateHostedNumbersAuthorizationDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AddressSid": {
"description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.",
"maxLength": 34,
"minLength": 34,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"CcEmails": {
"description": "Email recipients who will be informed when an Authorization Document has been sent and signed",
"items": {
"type": "string"
},
"type": "array"
},
"ContactPhoneNumber": {
"description": "The contact phone number of the person authorized to sign the Authorization Document.",
"type": "string"
},
"ContactTitle": {
"description": "The title of the person authorized to sign the Authorization Document for this phone number.",
"type": "string"
},
"Email": {
"description": "Email that this AuthorizationDocument will be sent to for signing.",
"type": "string"
},
"HostedNumberOrderSids": {
"description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.",
"items": {
"type": "string"
},
"type": "array"
},
"Status": {
"$ref": "#/components/schemas/authorization_document_enum_status",
"description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.",
"type": "string"
}
},
"title": "UpdateHostedNumbersAuthorizationDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.authorization_document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.",
"operationId": "ListHostedNumbersDependentHostedNumberOrder",
"parameters": [
{
"description": "",
"in": "path",
"name": "SigningDocumentSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.",
"in": "query",
"name": "Status",
"schema": {
"$ref": "#/components/schemas/dependent_hosted_number_order_enum_status",
"type": "string"
}
},
{
"description": "An E164 formatted phone number hosted by this HostedNumberOrder.",
"in": "query",
"name": "PhoneNumber",
"schema": {
"format": "phone-number",
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.",
"in": "query",
"name": "IncomingPhoneNumberSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^PN[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "A human readable description of this resource, up to 64 characters.",
"in": "query",
"name": "FriendlyName",
"schema": {
"type": "string"
}
},
{
"description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"in": "query",
"name": "UniqueName",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/preview.hosted_numbers.authorization_document.dependent_hosted_number_order"
},
"type": "array"
},
"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": "ListHostedNumbersDependentHostedNumberOrderResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/AuthorizationDocuments/{Sid}",
"pathType": "list"
}
},
"/HostedNumbers/HostedNumberOrders": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of HostedNumberOrders belonging to the account initiating the request.",
"operationId": "ListHostedNumbersHostedNumberOrder",
"parameters": [
{
"description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.",
"in": "query",
"name": "Status",
"schema": {
"$ref": "#/components/schemas/hosted_number_order_enum_status",
"type": "string"
}
},
{
"description": "An E164 formatted phone number hosted by this HostedNumberOrder.",
"in": "query",
"name": "PhoneNumber",
"schema": {
"format": "phone-number",
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.",
"in": "query",
"name": "IncomingPhoneNumberSid",
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^PN[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "A human readable description of this resource, up to 64 characters.",
"in": "query",
"name": "FriendlyName",
"schema": {
"type": "string"
}
},
{
"description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"in": "query",
"name": "UniqueName",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order"
},
"type": "array"
},
"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": "ListHostedNumbersHostedNumberOrderResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Host a phone number's capability on Twilio's platform.",
"operationId": "CreateHostedNumbersHostedNumberOrder",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AccountSid": {
"description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.",
"maxLength": 34,
"minLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"AddressSid": {
"description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.",
"maxLength": 34,
"minLength": 34,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"CcEmails": {
"description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.",
"items": {
"type": "string"
},
"type": "array"
},
"Email": {
"description": "Optional. Email of the owner of this phone number that is being hosted.",
"type": "string"
},
"FriendlyName": {
"description": "A 64 character string that is a human readable text that describes this resource.",
"type": "string"
},
"PhoneNumber": {
"description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format",
"format": "phone-number",
"type": "string"
},
"SmsApplicationSid": {
"description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.",
"maxLength": 34,
"minLength": 34,
"pattern": "^AP[0-9a-fA-F]{32}$",
"type": "string"
},
"SmsCapability": {
"description": "Used to specify that the SMS capability will be hosted on Twilio's platform.",
"type": "boolean"
},
"SmsFallbackMethod": {
"description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"SmsFallbackUrl": {
"description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.",
"format": "uri",
"type": "string"
},
"SmsMethod": {
"description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"SmsUrl": {
"description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.",
"format": "uri",
"type": "string"
},
"StatusCallbackMethod": {
"description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"StatusCallbackUrl": {
"description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.",
"format": "uri",
"type": "string"
},
"UniqueName": {
"description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"type": "string"
},
"VerificationDocumentSid": {
"description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RI[0-9a-fA-F]{32}$",
"type": "string"
},
"VerificationType": {
"$ref": "#/components/schemas/hosted_number_order_enum_verification_type",
"description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.",
"type": "string"
}
},
"required": [
"PhoneNumber",
"SmsCapability"
],
"title": "CreateHostedNumbersHostedNumberOrderRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/HostedNumbers/HostedNumberOrders/{Sid}": {
"delete": {
"description": "Cancel the HostedNumberOrder (only available when the status is in `received`).",
"operationId": "DeleteHostedNumbersHostedNumberOrder",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this HostedNumberOrder.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^HR[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific HostedNumberOrder.",
"operationId": "FetchHostedNumbersHostedNumberOrder",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this HostedNumberOrder.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^HR[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Updates a specific HostedNumberOrder.",
"operationId": "UpdateHostedNumbersHostedNumberOrder",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^HR[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CallDelay": {
"description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.",
"type": "integer"
},
"CcEmails": {
"description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.",
"items": {
"type": "string"
},
"type": "array"
},
"Email": {
"description": "Email of the owner of this phone number that is being hosted.",
"type": "string"
},
"Extension": {
"description": "Digits to dial after connecting the verification call.",
"type": "string"
},
"FriendlyName": {
"description": "A 64 character string that is a human readable text that describes this resource.",
"type": "string"
},
"Status": {
"$ref": "#/components/schemas/hosted_number_order_enum_status",
"description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.",
"type": "string"
},
"UniqueName": {
"description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"type": "string"
},
"VerificationCode": {
"description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.",
"type": "string"
},
"VerificationDocumentSid": {
"description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.",
"maxLength": 34,
"minLength": 34,
"pattern": "^RI[0-9a-fA-F]{32}$",
"type": "string"
},
"VerificationType": {
"$ref": "#/components/schemas/hosted_number_order_enum_verification_type",
"description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.",
"type": "string"
}
},
"title": "UpdateHostedNumbersHostedNumberOrderRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/Sync/Services": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncService",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"services": {
"items": {
"$ref": "#/components/schemas/preview.sync.service"
},
"type": "array"
}
},
"title": "ListSyncServiceResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncService",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AclEnabled": {
"description": "",
"type": "boolean"
},
"FriendlyName": {
"description": "",
"type": "string"
},
"ReachabilityWebhooksEnabled": {
"description": "",
"type": "boolean"
},
"WebhookUrl": {
"description": "",
"format": "uri",
"type": "string"
}
},
"title": "CreateSyncServiceRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Documents": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"documents": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.document"
},
"type": "array"
},
"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": "ListSyncDocumentResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
},
"UniqueName": {
"description": "",
"type": "string"
}
},
"title": "CreateSyncDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.document"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Services/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Permissions applying to a Sync Document.",
"operationId": "ListSyncDocumentPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Document. Either a SID or a unique name.",
"in": "path",
"name": "DocumentSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"permissions": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.document.document_permission"
},
"type": "array"
}
},
"title": "ListSyncDocumentPermissionResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "document_permissions",
"parent": "/Services/{ServiceSid}/Documents/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions/{Identity}": {
"delete": {
"description": "Delete a specific Sync Document Permission.",
"operationId": "DeleteSyncDocumentPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Document. Either a SID or a unique name.",
"in": "path",
"name": "DocumentSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Sync Document Permission.",
"operationId": "FetchSyncDocumentPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Document. Either a SID or a unique name.",
"in": "path",
"name": "DocumentSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.document.document_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update an identity's access to a specific Sync Document.",
"operationId": "UpdateSyncDocumentPermission",
"parameters": [
{
"description": "The unique SID identifier of the Sync Service Instance.",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Document. Either a SID or a unique name.",
"in": "path",
"name": "DocumentSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync Document.",
"type": "boolean"
},
"Read": {
"description": "Boolean flag specifying whether the identity can read the Sync Document.",
"type": "boolean"
},
"Write": {
"description": "Boolean flag specifying whether the identity can update the Sync Document.",
"type": "boolean"
}
},
"required": [
"Read",
"Write",
"Manage"
],
"title": "UpdateSyncDocumentPermissionRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.document.document_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "document_permissions",
"parent": "/Services/{ServiceSid}/Documents/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Documents/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteSyncDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateSyncDocument",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The If-Match HTTP request header",
"in": "header",
"name": "If-Match",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
}
},
"required": [
"Data"
],
"title": "UpdateSyncDocumentRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.document"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Services/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Lists": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncSyncList",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"lists": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_list"
},
"type": "array"
},
"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": "ListSyncSyncListResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncSyncList",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"UniqueName": {
"description": "",
"type": "string"
}
},
"title": "CreateSyncSyncListRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_lists",
"parent": "/Services/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncSyncListItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Order",
"schema": {
"$ref": "#/components/schemas/sync_list_item_enum_query_result_order",
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "From",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Bounds",
"schema": {
"$ref": "#/components/schemas/sync_list_item_enum_query_from_bound_type",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item"
},
"type": "array"
},
"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": "ListSyncSyncListItemResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncSyncListItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
}
},
"required": [
"Data"
],
"title": "CreateSyncSyncListItemRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_list_items",
"parent": "/Services/{ServiceSid}/Lists/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}": {
"delete": {
"description": "",
"operationId": "DeleteSyncSyncListItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Index",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "The If-Match HTTP request header",
"in": "header",
"name": "If-Match",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncSyncListItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Index",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateSyncSyncListItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Index",
"required": true,
"schema": {
"type": "integer"
}
},
{
"description": "The If-Match HTTP request header",
"in": "header",
"name": "If-Match",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
}
},
"required": [
"Data"
],
"title": "UpdateSyncSyncListItemRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_list_items",
"parent": "/Services/{ServiceSid}/Lists/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Permissions applying to a Sync List.",
"operationId": "ListSyncSyncListPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync List. Either a SID or a unique name.",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"permissions": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission"
},
"type": "array"
}
},
"title": "ListSyncSyncListPermissionResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_list_permissions",
"parent": "/Services/{ServiceSid}/Lists/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Lists/{ListSid}/Permissions/{Identity}": {
"delete": {
"description": "Delete a specific Sync List Permission.",
"operationId": "DeleteSyncSyncListPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync List. Either a SID or a unique name.",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Sync List Permission.",
"operationId": "FetchSyncSyncListPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync List. Either a SID or a unique name.",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update an identity's access to a specific Sync List.",
"operationId": "UpdateSyncSyncListPermission",
"parameters": [
{
"description": "The unique SID identifier of the Sync Service Instance.",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync List. Either a SID or a unique name.",
"in": "path",
"name": "ListSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync List.",
"type": "boolean"
},
"Read": {
"description": "Boolean flag specifying whether the identity can read the Sync List.",
"type": "boolean"
},
"Write": {
"description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.",
"type": "boolean"
}
},
"required": [
"Read",
"Write",
"Manage"
],
"title": "UpdateSyncSyncListPermissionRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_list_permissions",
"parent": "/Services/{ServiceSid}/Lists/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Lists/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteSyncSyncList",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncSyncList",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_list"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_lists",
"parent": "/Services/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Maps": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncSyncMap",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"maps": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_map"
},
"type": "array"
},
"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": "ListSyncSyncMapResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncSyncMap",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"UniqueName": {
"description": "",
"type": "string"
}
},
"title": "CreateSyncSyncMapRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_maps",
"parent": "/Services/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListSyncSyncMapItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Order",
"schema": {
"$ref": "#/components/schemas/sync_map_item_enum_query_result_order",
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "From",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Bounds",
"schema": {
"$ref": "#/components/schemas/sync_map_item_enum_query_from_bound_type",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item"
},
"type": "array"
},
"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": "ListSyncSyncMapItemResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateSyncSyncMapItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
},
"Key": {
"description": "",
"type": "string"
}
},
"required": [
"Key",
"Data"
],
"title": "CreateSyncSyncMapItemRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_map_items",
"parent": "/Services/{ServiceSid}/Maps/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}": {
"delete": {
"description": "",
"operationId": "DeleteSyncSyncMapItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Key",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The If-Match HTTP request header",
"in": "header",
"name": "If-Match",
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncSyncMapItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Key",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateSyncSyncMapItem",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Key",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The If-Match HTTP request header",
"in": "header",
"name": "If-Match",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Data": {
"description": ""
}
},
"required": [
"Data"
],
"title": "UpdateSyncSyncMapItemRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_map_items",
"parent": "/Services/{ServiceSid}/Maps/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of all Permissions applying to a Sync Map.",
"operationId": "ListSyncSyncMapPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Map. Either a SID or a unique name.",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"permissions": {
"items": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission"
},
"type": "array"
}
},
"title": "ListSyncSyncMapPermissionResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_map_permissions",
"parent": "/Services/{ServiceSid}/Maps/{Sid}",
"pathType": "list"
}
},
"/Sync/Services/{ServiceSid}/Maps/{MapSid}/Permissions/{Identity}": {
"delete": {
"description": "Delete a specific Sync Map Permission.",
"operationId": "DeleteSyncSyncMapPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Map. Either a SID or a unique name.",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch a specific Sync Map Permission.",
"operationId": "FetchSyncSyncMapPermission",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Map. Either a SID or a unique name.",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update an identity's access to a specific Sync Map.",
"operationId": "UpdateSyncSyncMapPermission",
"parameters": [
{
"description": "The unique SID identifier of the Sync Service Instance.",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "Identifier of the Sync Map. Either a SID or a unique name.",
"in": "path",
"name": "MapSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"in": "path",
"name": "Identity",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync Map.",
"type": "boolean"
},
"Read": {
"description": "Boolean flag specifying whether the identity can read the Sync Map.",
"type": "boolean"
},
"Write": {
"description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.",
"type": "boolean"
}
},
"required": [
"Read",
"Write",
"Manage"
],
"title": "UpdateSyncSyncMapPermissionRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_map_permissions",
"parent": "/Services/{ServiceSid}/Maps/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{ServiceSid}/Maps/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteSyncSyncMap",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncSyncMap",
"parameters": [
{
"description": "",
"in": "path",
"name": "ServiceSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service.sync_map"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"mountName": "sync_maps",
"parent": "/Services/{Sid}",
"pathType": "instance"
}
},
"/Sync/Services/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteSyncService",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchSyncService",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateSyncService",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AclEnabled": {
"description": "",
"type": "boolean"
},
"FriendlyName": {
"description": "",
"type": "string"
},
"ReachabilityWebhooksEnabled": {
"description": "",
"type": "boolean"
},
"WebhookUrl": {
"description": "",
"format": "uri",
"type": "string"
}
},
"title": "UpdateSyncServiceRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.sync.service"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/marketplace/AvailableAddOns": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Add-ons currently available to be installed.",
"operationId": "ListMarketplaceAvailableAddOn",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"available_add_ons": {
"items": {
"$ref": "#/components/schemas/preview.marketplace.available_add_on"
},
"type": "array"
},
"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": "ListMarketplaceAvailableAddOnResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Extensions for the Available Add-on.",
"operationId": "ListMarketplaceAvailableAddOnExtension",
"parameters": [
{
"description": "The SID of the AvailableAddOn resource with the extensions to read.",
"in": "path",
"name": "AvailableAddOnSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"extensions": {
"items": {
"$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension"
},
"type": "array"
},
"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": "ListMarketplaceAvailableAddOnExtensionResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "available_add_on_extension",
"defaultOutputProperties": [],
"parent": "/AvailableAddOns/{Sid}",
"pathType": "list"
}
},
"/marketplace/AvailableAddOns/{AvailableAddOnSid}/Extensions/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch an instance of an Extension for the Available Add-on.",
"operationId": "FetchMarketplaceAvailableAddOnExtension",
"parameters": [
{
"description": "The SID of the AvailableAddOn resource with the extension to fetch.",
"in": "path",
"name": "AvailableAddOnSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The SID of the AvailableAddOn Extension resource to fetch.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "available_add_on_extension",
"defaultOutputProperties": [],
"parent": "/AvailableAddOns/{Sid}",
"pathType": "instance"
}
},
"/marketplace/AvailableAddOns/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch an instance of an Add-on currently available to be installed.",
"operationId": "FetchMarketplaceAvailableAddOn",
"parameters": [
{
"description": "The SID of the AvailableAddOn resource to fetch.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.available_add_on"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/marketplace/InstalledAddOns": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Add-ons currently installed on this Account.",
"operationId": "ListMarketplaceInstalledAddOn",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"installed_add_ons": {
"items": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on"
},
"type": "array"
},
"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": "ListMarketplaceInstalledAddOnResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Install an Add-on for the Account specified.",
"operationId": "CreateMarketplaceInstalledAddOn",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"AcceptTermsOfService": {
"description": "Whether the Terms of Service were accepted.",
"type": "boolean"
},
"AvailableAddOnSid": {
"description": "The SID of the AvaliableAddOn to install.",
"maxLength": 34,
"minLength": 34,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
},
"Configuration": {
"description": "The JSON object that represents the configuration of the new Add-on being installed."
},
"UniqueName": {
"description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.",
"type": "string"
}
},
"required": [
"AvailableAddOnSid",
"AcceptTermsOfService"
],
"title": "CreateMarketplaceInstalledAddOnRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Retrieve a list of Extensions for the Installed Add-on.",
"operationId": "ListMarketplaceInstalledAddOnExtension",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource with the extensions to read.",
"in": "path",
"name": "InstalledAddOnSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"extensions": {
"items": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension"
},
"type": "array"
},
"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": "ListMarketplaceInstalledAddOnExtensionResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "installed_add_on_extension",
"defaultOutputProperties": [],
"parent": "/InstalledAddOns/{Sid}",
"pathType": "list"
}
},
"/marketplace/InstalledAddOns/{InstalledAddOnSid}/Extensions/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch an instance of an Extension for the Installed Add-on.",
"operationId": "FetchMarketplaceInstalledAddOnExtension",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource with the extension to fetch.",
"in": "path",
"name": "InstalledAddOnSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The SID of the InstalledAddOn Extension resource to fetch.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update an Extension for an Add-on installation.",
"operationId": "UpdateMarketplaceInstalledAddOnExtension",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource with the extension to update.",
"in": "path",
"name": "InstalledAddOnSid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
},
{
"description": "The SID of the InstalledAddOn Extension resource to update.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Enabled": {
"description": "Whether the Extension should be invoked.",
"type": "boolean"
}
},
"required": [
"Enabled"
],
"title": "UpdateMarketplaceInstalledAddOnExtensionRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "installed_add_on_extension",
"defaultOutputProperties": [],
"parent": "/InstalledAddOns/{Sid}",
"pathType": "instance"
}
},
"/marketplace/InstalledAddOns/{Sid}": {
"delete": {
"description": "Remove an Add-on installation from your account",
"operationId": "DeleteMarketplaceInstalledAddOn",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource to delete.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "Fetch an instance of an Add-on currently installed on this Account.",
"operationId": "FetchMarketplaceInstalledAddOn",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource to fetch.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Update an Add-on installation for the Account specified.",
"operationId": "UpdateMarketplaceInstalledAddOn",
"parameters": [
{
"description": "The SID of the InstalledAddOn resource to update.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Configuration": {
"description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured"
},
"UniqueName": {
"description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.",
"type": "string"
}
},
"title": "UpdateMarketplaceInstalledAddOnRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.marketplace.installed_add_on"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/understand/Assistants": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandAssistant",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"assistants": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant"
},
"type": "array"
},
"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": "ListUnderstandAssistantResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandAssistant",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CallbackEvents": {
"description": "Space-separated list of callback events that will trigger callbacks.",
"type": "string"
},
"CallbackUrl": {
"description": "A user-provided URL to send event callbacks to.",
"format": "uri",
"type": "string"
},
"FallbackActions": {
"description": "The JSON actions to be executed when the user's input is not recognized as matching any Task."
},
"FriendlyName": {
"description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"InitiationActions": {
"description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first."
},
"LogQueries": {
"description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.",
"type": "boolean"
},
"StyleSheet": {
"description": "The JSON object that holds the style sheet for the assistant"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"title": "CreateUnderstandAssistantRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Dialogues": {
"description": "TODO: Resource-level docs",
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Dialogues/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandDialogue",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.dialogue"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/FallbackActions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandAssistantFallbackActions",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandAssistantFallbackActions",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FallbackActions": {
"description": ""
}
},
"title": "UpdateUnderstandAssistantFallbackActionsRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "assistant_fallback_actions",
"defaultOutputProperties": [],
"mountName": "assistant_fallback_actions",
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/FieldTypes": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandFieldType",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"field_types": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type"
},
"type": "array"
},
"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": "ListUnderstandFieldTypeResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandFieldType",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"required": [
"UniqueName"
],
"title": "CreateUnderstandFieldTypeRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandFieldValue",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "FieldTypeSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "An ISO language-country string of the value. For example: *en-US*",
"in": "query",
"name": "Language",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"field_values": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value"
},
"type": "array"
},
"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": "ListUnderstandFieldValueResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandFieldValue",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "FieldTypeSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Language": {
"description": "An ISO language-country string of the value.",
"type": "string"
},
"SynonymOf": {
"description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.",
"type": "string"
},
"Value": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"required": [
"Language",
"Value"
],
"title": "CreateUnderstandFieldValueRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/FieldTypes/{FieldTypeSid}/FieldValues/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandFieldValue",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "FieldTypeSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandFieldValue",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "FieldTypeSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/FieldTypes/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/FieldTypes/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandFieldType",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandFieldType",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandFieldType",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"title": "UpdateUnderstandFieldTypeRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.field_type"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/InitiationActions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandAssistantInitiationActions",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandAssistantInitiationActions",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"InitiationActions": {
"description": ""
}
},
"title": "UpdateUnderstandAssistantInitiationActionsRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "assistant_initiation_actions",
"defaultOutputProperties": [],
"mountName": "assistant_initiation_actions",
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/ModelBuilds": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandModelBuild",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"model_builds": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.model_build"
},
"type": "array"
}
},
"title": "ListUnderstandModelBuildResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandModelBuild",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"StatusCallback": {
"description": "",
"format": "uri",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1",
"type": "string"
}
},
"title": "CreateUnderstandModelBuildRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.model_build"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/ModelBuilds/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandModelBuild",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandModelBuild",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.model_build"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandModelBuild",
"parameters": [
{
"description": "",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1",
"type": "string"
}
},
"title": "UpdateUnderstandModelBuildRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.model_build"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Queries": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandQuery",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "An ISO language-country string of the sample.",
"in": "query",
"name": "Language",
"schema": {
"type": "string"
}
},
{
"description": "The Model Build Sid or unique name of the Model Build to be queried.",
"in": "query",
"name": "ModelBuild",
"schema": {
"type": "string"
}
},
{
"description": "A string that described the query status. The values can be: pending_review, reviewed, discarded",
"in": "query",
"name": "Status",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"queries": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.query"
},
"type": "array"
}
},
"title": "ListUnderstandQueryResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandQuery",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Field": {
"description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*",
"type": "string"
},
"Language": {
"description": "An ISO language-country string of the sample.",
"type": "string"
},
"ModelBuild": {
"description": "The Model Build Sid or unique name of the Model Build to be queried.",
"type": "string"
},
"Query": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.",
"type": "string"
},
"Tasks": {
"description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*",
"type": "string"
}
},
"required": [
"Language",
"Query"
],
"title": "CreateUnderstandQueryRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.query"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Queries/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandQuery",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandQuery",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.query"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandQuery",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"SampleSid": {
"description": "An optional reference to the Sample created from this query.",
"maxLength": 34,
"minLength": 34,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
},
"Status": {
"description": "A string that described the query status. The values can be: pending_review, reviewed, discarded",
"type": "string"
}
},
"title": "UpdateUnderstandQueryRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.query"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/StyleSheet": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Returns Style sheet JSON object for this Assistant",
"operationId": "FetchUnderstandStyleSheet",
"parameters": [
{
"description": "The unique ID of the Assistant",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.style_sheet"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Updates the style sheet for an assistant identified by {AssistantSid} or {AssistantUniqueName}.",
"operationId": "UpdateUnderstandStyleSheet",
"parameters": [
{
"description": "The unique ID of the Assistant",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"StyleSheet": {
"description": "The JSON Style sheet string"
}
},
"title": "UpdateUnderstandStyleSheetRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.style_sheet"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Tasks": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandTask",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.task"
},
"type": "array"
}
},
"title": "ListUnderstandTaskResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandTask",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Actions": {
"description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique."
},
"ActionsUrl": {
"description": "User-provided HTTP endpoint where from the assistant fetches actions",
"format": "uri",
"type": "string"
},
"FriendlyName": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"required": [
"UniqueName"
],
"title": "CreateUnderstandTaskRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandTask",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandTask",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandTask",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Actions": {
"description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique."
},
"ActionsUrl": {
"description": "User-provided HTTP endpoint where from the assistant fetches actions",
"format": "uri",
"type": "string"
},
"FriendlyName": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"title": "UpdateUnderstandTaskRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Actions": {
"description": "TODO: Resource-level docs",
"get": {
"description": "Returns JSON actions for this Task.",
"operationId": "FetchUnderstandTaskActions",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.task_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "Updates the actions of an Task identified by {TaskSid} or {TaskUniqueName}.",
"operationId": "UpdateUnderstandTaskActions",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Actions": {
"description": "The JSON actions that instruct the Assistant how to perform this task."
}
},
"title": "UpdateUnderstandTaskActionsRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.task_actions"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "task_actions",
"defaultOutputProperties": [],
"mountName": "task_actions",
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandField",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Field.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"fields": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.task.field"
},
"type": "array"
},
"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": "ListUnderstandFieldResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandField",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Field.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FieldType": {
"description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.",
"type": "string"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"required": [
"FieldType",
"UniqueName"
],
"title": "CreateUnderstandFieldRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.field"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Fields/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandField",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Field.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandField",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Field.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.field"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListUnderstandSample",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Sample.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "An ISO language-country string of the sample.",
"in": "query",
"name": "Language",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"samples": {
"items": {
"$ref": "#/components/schemas/preview.understand.assistant.task.sample"
},
"type": "array"
}
},
"title": "ListUnderstandSampleResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateUnderstandSample",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Sample.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Language": {
"description": "An ISO language-country string of the sample.",
"type": "string"
},
"SourceChannel": {
"description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null",
"type": "string"
},
"TaggedText": {
"description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.",
"type": "string"
}
},
"required": [
"Language",
"TaggedText"
],
"title": "CreateUnderstandSampleRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.sample"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "list"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Samples/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandSample",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Sample.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandSample",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Sample.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.sample"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandSample",
"parameters": [
{
"description": "The unique ID of the Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Sample.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"Language": {
"description": "An ISO language-country string of the sample.",
"type": "string"
},
"SourceChannel": {
"description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null",
"type": "string"
},
"TaggedText": {
"description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.",
"type": "string"
}
},
"title": "UpdateUnderstandSampleRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.sample"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{AssistantSid}/Tasks/{TaskSid}/Statistics": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandTaskStatistics",
"parameters": [
{
"description": "The unique ID of the parent Assistant.",
"in": "path",
"name": "AssistantSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The unique ID of the Task associated with this Field.",
"in": "path",
"name": "TaskSid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"className": "task_statistics",
"defaultOutputProperties": [],
"parent": "/Assistants/{AssistantSid}/Tasks/{Sid}",
"pathType": "instance"
}
},
"/understand/Assistants/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteUnderstandAssistant",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchUnderstandAssistant",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateUnderstandAssistant",
"parameters": [
{
"description": "A 34 character string that uniquely identifies this resource.",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CallbackEvents": {
"description": "Space-separated list of callback events that will trigger callbacks.",
"type": "string"
},
"CallbackUrl": {
"description": "A user-provided URL to send event callbacks to.",
"format": "uri",
"type": "string"
},
"FallbackActions": {
"description": "The JSON actions to be executed when the user's input is not recognized as matching any Task."
},
"FriendlyName": {
"description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.",
"type": "string"
},
"InitiationActions": {
"description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first."
},
"LogQueries": {
"description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.",
"type": "boolean"
},
"StyleSheet": {
"description": "The JSON object that holds the style sheet for the assistant"
},
"UniqueName": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"type": "string"
}
},
"title": "UpdateUnderstandAssistantRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.understand.assistant"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/wireless/Commands": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListWirelessCommand",
"parameters": [
{
"description": "",
"in": "query",
"name": "Device",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Sim",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Status",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Direction",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"commands": {
"items": {
"$ref": "#/components/schemas/preview.wireless.command"
},
"type": "array"
},
"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": "ListWirelessCommandResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateWirelessCommand",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CallbackMethod": {
"description": "",
"type": "string"
},
"CallbackUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"Command": {
"description": "",
"type": "string"
},
"CommandMode": {
"description": "",
"type": "string"
},
"Device": {
"description": "",
"type": "string"
},
"IncludeSid": {
"description": "",
"type": "string"
},
"Sim": {
"description": "",
"type": "string"
}
},
"required": [
"Command"
],
"title": "CreateWirelessCommandRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.command"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/wireless/Commands/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchWirelessCommand",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"maxLength": 34,
"minLength": 34,
"pattern": "^DC[0-9a-fA-F]{32}$",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.command"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/wireless/RatePlans": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListWirelessRatePlan",
"parameters": [
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"rate_plans": {
"items": {
"$ref": "#/components/schemas/preview.wireless.rate_plan"
},
"type": "array"
}
},
"title": "ListWirelessRatePlanResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "CreateWirelessRatePlan",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CommandsEnabled": {
"description": "",
"type": "boolean"
},
"DataEnabled": {
"description": "",
"type": "boolean"
},
"DataLimit": {
"description": "",
"type": "integer"
},
"DataMetering": {
"description": "",
"type": "string"
},
"FriendlyName": {
"description": "",
"type": "string"
},
"InternationalRoaming": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"MessagingEnabled": {
"description": "",
"type": "boolean"
},
"NationalRoamingEnabled": {
"description": "",
"type": "boolean"
},
"UniqueName": {
"description": "",
"type": "string"
},
"VoiceEnabled": {
"description": "",
"type": "boolean"
}
},
"title": "CreateWirelessRatePlanRequest",
"type": "object"
}
}
}
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.rate_plan"
}
}
},
"description": "Created"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/wireless/RatePlans/{Sid}": {
"delete": {
"description": "",
"operationId": "DeleteWirelessRatePlan",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "The resource was deleted successfully."
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchWirelessRatePlan",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.rate_plan"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateWirelessRatePlan",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"FriendlyName": {
"description": "",
"type": "string"
},
"UniqueName": {
"description": "",
"type": "string"
}
},
"title": "UpdateWirelessRatePlanRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.rate_plan"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/wireless/Sims": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "ListWirelessSim",
"parameters": [
{
"description": "",
"in": "query",
"name": "Status",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Iccid",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "RatePlan",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "EId",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "SimRegistrationCode",
"schema": {
"type": "string"
}
},
{
"description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
"in": "query",
"name": "PageSize",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "The page index. This value is simply for client state.",
"in": "query",
"name": "Page",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "The page token. This is provided by the API.",
"in": "query",
"name": "PageToken",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"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"
},
"sims": {
"items": {
"$ref": "#/components/schemas/preview.wireless.sim"
},
"type": "array"
}
},
"title": "ListWirelessSimResponse",
"type": "object"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "list"
}
},
"/wireless/Sims/{Sid}": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchWirelessSim",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.sim"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"post": {
"description": "",
"operationId": "UpdateWirelessSim",
"parameters": [
{
"description": "",
"in": "path",
"name": "Sid",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"properties": {
"CallbackMethod": {
"description": "",
"type": "string"
},
"CallbackUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"CommandsCallbackMethod": {
"description": "",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"CommandsCallbackUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"FriendlyName": {
"description": "",
"type": "string"
},
"RatePlan": {
"description": "",
"type": "string"
},
"SmsFallbackMethod": {
"description": "",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"SmsFallbackUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"SmsMethod": {
"description": "",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"SmsUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"Status": {
"description": "",
"type": "string"
},
"UniqueName": {
"description": "",
"type": "string"
},
"VoiceFallbackMethod": {
"description": "",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"VoiceFallbackUrl": {
"description": "",
"format": "uri",
"type": "string"
},
"VoiceMethod": {
"description": "",
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"type": "string"
},
"VoiceUrl": {
"description": "",
"format": "uri",
"type": "string"
}
},
"title": "UpdateWirelessSimRequest",
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.sim"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"pathType": "instance"
}
},
"/wireless/Sims/{SimSid}/Usage": {
"description": "TODO: Resource-level docs",
"get": {
"description": "",
"operationId": "FetchWirelessUsage",
"parameters": [
{
"description": "",
"in": "path",
"name": "SimSid",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "End",
"schema": {
"type": "string"
}
},
{
"description": "",
"in": "query",
"name": "Start",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/preview.wireless.sim.usage"
}
}
},
"description": "OK"
}
},
"security": [
{
"accountSid_authToken": []
}
],
"x-maturity": [
"Preview"
]
},
"servers": [
{
"url": "https://preview.twilio.com"
}
],
"x-twilio": {
"defaultOutputProperties": [],
"parent": "/Sims/{Sid}",
"pathType": "instance"
}
}
},
"components": {
"schemas": {
"authorization_document_enum_status": {
"enum": [
"opened",
"signing",
"signed",
"canceled",
"failed"
],
"type": "string"
},
"dependent_hosted_number_order_enum_status": {
"enum": [
"received",
"pending-verification",
"verified",
"pending-loa",
"carrier-processing",
"testing",
"completed",
"failed",
"action-required"
],
"type": "string"
},
"dependent_hosted_number_order_enum_verification_type": {
"enum": [
"phone-call",
"phone-bill"
],
"type": "string"
},
"hosted_number_order_enum_status": {
"enum": [
"received",
"pending-verification",
"verified",
"pending-loa",
"carrier-processing",
"testing",
"completed",
"failed",
"action-required"
],
"type": "string"
},
"hosted_number_order_enum_verification_type": {
"enum": [
"phone-call",
"phone-bill"
],
"type": "string"
},
"model_build_enum_status": {
"enum": [
"enqueued",
"building",
"completed",
"failed",
"canceled"
],
"type": "string"
},
"preview.deployed_devices.fleet": {
"properties": {
"account_sid": {
"description": "Speicifies the unique string identifier of the Account responsible for this Fleet.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "Specifies the date this Fleet was created, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "Specifies the date this Fleet was last updated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"default_deployment_sid": {
"description": "Contains the string identifier of the automatically provisioned default Deployment of this Fleet.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"friendly_name": {
"description": "Contains a human readable descriptive text for this Fleet, up to 256 characters long.",
"nullable": true,
"type": "string"
},
"links": {
"description": "Contains a dictionary of URL links to nested resources of this Fleet.",
"format": "uri-map",
"nullable": true,
"type": "object"
},
"sid": {
"description": "Contains a 34 character string that uniquely identifies this Fleet resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "Contains a unique and addressable name of this Fleet, e.g. 'default', up to 128 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Fleet resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.deployed_devices.fleet.certificate": {
"properties": {
"account_sid": {
"description": "Specifies the unique string identifier of the Account responsible for this Certificate credential.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "Specifies the date this Certificate credential was created, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "Specifies the date this Certificate credential was last updated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"device_sid": {
"description": "Specifies the unique string identifier of a Device authenticated with this Certificate credential.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"fleet_sid": {
"description": "Specifies the unique string identifier of the Fleet that the given Certificate credential belongs to.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "Contains a human readable descriptive text for this Certificate credential, up to 256 characters long.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "Contains a 34 character string that uniquely identifies this Certificate credential resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^CY[0-9a-fA-F]{32}$",
"type": "string"
},
"thumbprint": {
"description": "Contains a unique hash of the payload of this Certificate credential, used to authenticate the Device.",
"nullable": true,
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Certificate credential resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.deployed_devices.fleet.deployment": {
"properties": {
"account_sid": {
"description": "Specifies the unique string identifier of the Account responsible for this Deployment.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "Specifies the date this Deployment was created, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "Specifies the date this Deployment was last updated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"fleet_sid": {
"description": "Specifies the unique string identifier of the Fleet that the given Deployment belongs to.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "Contains a human readable descriptive text for this Deployment, up to 64 characters long",
"nullable": true,
"type": "string"
},
"sid": {
"description": "Contains a 34 character string that uniquely identifies this Deployment resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"sync_service_sid": {
"description": "Specifies the unique string identifier of the Twilio Sync service instance linked to and accessible by this Deployment.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Deployment resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.deployed_devices.fleet.device": {
"properties": {
"account_sid": {
"description": "Specifies the unique string identifier of the Account responsible for this Device.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_authenticated": {
"description": "Specifies the date this Device was last authenticated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_created": {
"description": "Specifies the date this Device was created, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "Specifies the date this Device was last updated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"deployment_sid": {
"description": "Specifies the unique string identifier of the Deployment group that this Device is associated with.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DL[0-9a-fA-F]{32}$",
"type": "string"
},
"enabled": {
"description": "Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false.",
"nullable": true,
"type": "boolean"
},
"fleet_sid": {
"description": "Specifies the unique string identifier of the Fleet that the given Device belongs to.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "Contains a human readable descriptive text for this Device, up to 256 characters long",
"nullable": true,
"type": "string"
},
"identity": {
"description": "Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "Contains a 34 character string that uniquely identifies this Device resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Device resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.deployed_devices.fleet.key": {
"properties": {
"account_sid": {
"description": "Specifies the unique string identifier of the Account responsible for this Key credential.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "Specifies the date this Key credential was created, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "Specifies the date this Key credential was last updated, given in UTC ISO 8601 format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"device_sid": {
"description": "Specifies the unique string identifier of a Device authenticated with this Key credential.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^TH[0-9a-fA-F]{32}$",
"type": "string"
},
"fleet_sid": {
"description": "Specifies the unique string identifier of the Fleet that the given Key credential belongs to.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "Contains a human readable descriptive text for this Key credential, up to 256 characters long.",
"nullable": true,
"type": "string"
},
"secret": {
"description": "Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "Contains a 34 character string that uniquely identifies this Key credential resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^KY[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Key credential resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.hosted_numbers.authorization_document": {
"properties": {
"address_sid": {
"description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"cc_emails": {
"description": "Email recipients who will be informed when an Authorization Document has been sent and signed.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"date_created": {
"description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Email that this AuthorizationDocument will be sent to for signing.",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"sid": {
"description": "A 34 character string that uniquely identifies this AuthorizationDocument.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/authorization_document_enum_status",
"description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.hosted_numbers.authorization_document.dependent_hosted_number_order": {
"properties": {
"account_sid": {
"description": "The unique SID identifier of the Account.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"address_sid": {
"description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"call_delay": {
"description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.",
"nullable": true,
"type": "integer"
},
"capabilities": {
"description": "A mapping of capabilities this hosted phone number will have enabled on Twilio's platform.",
"format": "phone-number-capabilities",
"nullable": true,
"properties": {
"fax": {
"type": "boolean"
},
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
}
},
"type": "object"
},
"cc_emails": {
"description": "Email recipients who will be informed when an Authorization Document has been sent and signed",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"date_created": {
"description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Email of the owner of this phone number that is being hosted.",
"nullable": true,
"type": "string"
},
"extension": {
"description": "A numerical extension to be used when making the ownership verification call.",
"nullable": true,
"type": "string"
},
"failure_reason": {
"description": "A message that explains why a hosted_number_order went to status \"action-required\"",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "A human readable description of this resource, up to 64 characters.",
"nullable": true,
"type": "string"
},
"incoming_phone_number_sid": {
"description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^PN[0-9a-fA-F]{32}$",
"type": "string"
},
"phone_number": {
"description": "An E164 formatted phone number hosted by this HostedNumberOrder.",
"format": "phone-number",
"nullable": true,
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this Authorization Document",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^HR[0-9a-fA-F]{32}$",
"type": "string"
},
"signing_document_sid": {
"description": "A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/dependent_hosted_number_order_enum_status",
"description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.",
"nullable": true,
"type": "string"
},
"unique_name": {
"description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"nullable": true,
"type": "string"
},
"verification_attempts": {
"description": "The number of attempts made to verify ownership of the phone number that is being hosted.",
"nullable": true,
"type": "integer"
},
"verification_call_sids": {
"description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"verification_code": {
"description": "The digits passed during the ownership verification call.",
"nullable": true,
"type": "string"
},
"verification_document_sid": {
"description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RI[0-9a-fA-F]{32}$",
"type": "string"
},
"verification_type": {
"$ref": "#/components/schemas/dependent_hosted_number_order_enum_verification_type",
"description": "The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.hosted_numbers.hosted_number_order": {
"properties": {
"account_sid": {
"description": "A 34 character string that uniquely identifies the account.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"address_sid": {
"description": "A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AD[0-9a-fA-F]{32}$",
"type": "string"
},
"call_delay": {
"description": "A value between 0-30 specifying the number of seconds to delay initiating the ownership verification call.",
"nullable": true,
"type": "integer"
},
"capabilities": {
"description": "Set of booleans describing the capabilities hosted on Twilio's platform. SMS is currently only supported.",
"format": "phone-number-capabilities",
"nullable": true,
"properties": {
"fax": {
"type": "boolean"
},
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
}
},
"type": "object"
},
"cc_emails": {
"description": "A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"date_created": {
"description": "The date this resource was created, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was updated, given as [GMT RFC 2822](http://www.ietf.org/rfc/rfc2822.txt) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Email of the owner of this phone number that is being hosted.",
"nullable": true,
"type": "string"
},
"extension": {
"description": "A numerical extension to be used when making the ownership verification call.",
"nullable": true,
"type": "string"
},
"failure_reason": {
"description": "A message that explains why a hosted_number_order went to status \"action-required\"",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "A 64 character string that is a human-readable text that describes this resource.",
"nullable": true,
"type": "string"
},
"incoming_phone_number_sid": {
"description": "A 34 character string that uniquely identifies the [IncomingPhoneNumber](https://www.twilio.com/docs/api/rest/incoming-phone-numbers) resource that represents the phone number being hosted.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^PN[0-9a-fA-F]{32}$",
"type": "string"
},
"phone_number": {
"description": "Phone number to be hosted. This must be in [E.164](https://en.wikipedia.org/wiki/E.164) format, e.g., +16175551212",
"format": "phone-number",
"nullable": true,
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this HostedNumberOrder.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^HR[0-9a-fA-F]{32}$",
"type": "string"
},
"signing_document_sid": {
"description": "A 34 character string that uniquely identifies the [Authorization Document](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents) the user needs to sign.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^PX[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/hosted_number_order_enum_status",
"description": "Status of this resource. It can hold one of the values: 1. Twilio Processing 2. Received, 3. Pending LOA, 4. Carrier Processing, 5. Completed, 6. Action Required, 7. Failed. See the [HostedNumberOrders Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-numbers#status-values) section for more information on each of these statuses.",
"nullable": true,
"type": "string"
},
"unique_name": {
"description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The URL of this HostedNumberOrder.",
"format": "uri",
"nullable": true,
"type": "string"
},
"verification_attempts": {
"description": "The number of attempts made to verify ownership of the phone number that is being hosted.",
"nullable": true,
"type": "integer"
},
"verification_call_sids": {
"description": "A list of 34 character strings that are unique identifiers for the calls placed as part of ownership verification.",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"verification_code": {
"description": "A verification code provided in the response for a user to enter when they pick up the phone call.",
"nullable": true,
"type": "string"
},
"verification_document_sid": {
"description": "A 34 character string that uniquely identifies the Identity Document resource that represents the document for verifying ownership of the number to be hosted.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^RI[0-9a-fA-F]{32}$",
"type": "string"
},
"verification_type": {
"$ref": "#/components/schemas/hosted_number_order_enum_verification_type",
"description": "The type of ownership verification required to move the number to a `verified` state. The verification methods are `phone-call` or `phone-bill`.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.marketplace.available_add_on": {
"properties": {
"configuration_schema": {
"description": "The JSON object with the configuration that must be provided when installing a given Add-on.",
"nullable": true
},
"description": {
"description": "A short description of the Add-on's functionality.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"links": {
"description": "The URLs of related resources.",
"format": "uri-map",
"nullable": true,
"type": "object"
},
"pricing_type": {
"description": "How customers are charged for using this Add-on.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the AvailableAddOn resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "The absolute URL of the resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.marketplace.available_add_on.available_add_on_extension": {
"properties": {
"available_add_on_sid": {
"description": "The SID of the AvailableAddOn resource to which this extension applies.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XB[0-9a-fA-F]{32}$",
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"product_name": {
"description": "The name of the Product this Extension is used within.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the AvailableAddOnExtension resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XF[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "An application-defined string that uniquely identifies the resource.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.marketplace.installed_add_on": {
"properties": {
"account_sid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the InstalledAddOn resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"configuration": {
"description": "The JSON object that represents the current configuration of installed Add-on.",
"nullable": true
},
"date_created": {
"description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"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.",
"format": "date-time",
"nullable": true,
"type": "string"
},
"description": {
"description": "A short description of the Add-on's functionality.",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"links": {
"description": "The URLs of related resources.",
"format": "uri-map",
"nullable": true,
"type": "object"
},
"sid": {
"description": "The unique string that we created to identify the InstalledAddOn resource. This Sid can also be found in the Console on that specific Add-ons page as the 'Available Add-on Sid'.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "An application-defined string that uniquely identifies the resource.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.marketplace.installed_add_on.installed_add_on_extension": {
"properties": {
"enabled": {
"description": "Whether the Extension will be invoked.",
"nullable": true,
"type": "boolean"
},
"friendly_name": {
"description": "The string that you assigned to describe the resource.",
"nullable": true,
"type": "string"
},
"installed_add_on_sid": {
"description": "The SID of the InstalledAddOn resource to which this extension applies.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XE[0-9a-fA-F]{32}$",
"type": "string"
},
"product_name": {
"description": "The name of the Product this Extension is used within.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "The unique string that we created to identify the InstalledAddOn Extension resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^XF[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "An application-defined string that uniquely identifies the resource.",
"nullable": true,
"type": "string"
},
"url": {
"description": "The absolute URL of the resource.",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"acl_enabled": {
"nullable": true,
"type": "boolean"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"reachability_webhooks_enabled": {
"nullable": true,
"type": "boolean"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"webhook_url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.document": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"created_by": {
"nullable": true,
"type": "string"
},
"data": {
"nullable": true
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"revision": {
"nullable": true,
"type": "string"
},
"service_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^ET[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.document.document_permission": {
"properties": {
"account_sid": {
"description": "The unique SID identifier of the Twilio Account.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"document_sid": {
"description": "The unique SID identifier of the Sync Document to which the Permission applies.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^ET[0-9a-fA-F]{32}$",
"type": "string"
},
"identity": {
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"nullable": true,
"type": "string"
},
"manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync Document.",
"nullable": true,
"type": "boolean"
},
"read": {
"description": "Boolean flag specifying whether the identity can read the Sync Document.",
"nullable": true,
"type": "boolean"
},
"service_sid": {
"description": "The unique SID identifier of the Sync Service Instance.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Sync Document Permission.",
"format": "uri",
"nullable": true,
"type": "string"
},
"write": {
"description": "Boolean flag specifying whether the identity can update the Sync Document.",
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"preview.sync.service.sync_list": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"created_by": {
"nullable": true,
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"revision": {
"nullable": true,
"type": "string"
},
"service_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^ES[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.sync_list.sync_list_item": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"created_by": {
"nullable": true,
"type": "string"
},
"data": {
"nullable": true
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"index": {
"nullable": true,
"type": "integer"
},
"list_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^ES[0-9a-fA-F]{32}$",
"type": "string"
},
"revision": {
"nullable": true,
"type": "string"
},
"service_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.sync_list.sync_list_permission": {
"properties": {
"account_sid": {
"description": "The unique SID identifier of the Twilio Account.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"identity": {
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"nullable": true,
"type": "string"
},
"list_sid": {
"description": "The unique SID identifier of the Sync List to which the Permission applies.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^ES[0-9a-fA-F]{32}$",
"type": "string"
},
"manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync List.",
"nullable": true,
"type": "boolean"
},
"read": {
"description": "Boolean flag specifying whether the identity can read the Sync List and its Items.",
"nullable": true,
"type": "boolean"
},
"service_sid": {
"description": "The unique SID identifier of the Sync Service Instance.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Sync List Permission.",
"format": "uri",
"nullable": true,
"type": "string"
},
"write": {
"description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.",
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"preview.sync.service.sync_map": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"created_by": {
"nullable": true,
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"revision": {
"nullable": true,
"type": "string"
},
"service_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^MP[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.sync_map.sync_map_item": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"created_by": {
"nullable": true,
"type": "string"
},
"data": {
"nullable": true
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"key": {
"nullable": true,
"type": "string"
},
"map_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^MP[0-9a-fA-F]{32}$",
"type": "string"
},
"revision": {
"nullable": true,
"type": "string"
},
"service_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.sync.service.sync_map.sync_map_permission": {
"properties": {
"account_sid": {
"description": "The unique SID identifier of the Twilio Account.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"identity": {
"description": "Arbitrary string identifier representing a human user associated with an FPA token, assigned by the developer.",
"nullable": true,
"type": "string"
},
"manage": {
"description": "Boolean flag specifying whether the identity can delete the Sync Map.",
"nullable": true,
"type": "boolean"
},
"map_sid": {
"description": "The unique SID identifier of the Sync Map to which the Permission applies.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^MP[0-9a-fA-F]{32}$",
"type": "string"
},
"read": {
"description": "Boolean flag specifying whether the identity can read the Sync Map and its Items.",
"nullable": true,
"type": "boolean"
},
"service_sid": {
"description": "The unique SID identifier of the Sync Service Instance.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^IS[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"description": "Contains an absolute URL for this Sync Map Permission.",
"format": "uri",
"nullable": true,
"type": "string"
},
"write": {
"description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.",
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"preview.understand.assistant": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"callback_events": {
"description": "Space-separated list of callback events that will trigger callbacks.",
"nullable": true,
"type": "string"
},
"callback_url": {
"description": "A user-provided URL to send event callbacks to.",
"format": "uri",
"nullable": true,
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.",
"nullable": true,
"type": "string"
},
"latest_model_build_sid": {
"description": "The unique ID (Sid) of the latest model build. Null if no model has been built.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UG[0-9a-fA-F]{32}$",
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"log_queries": {
"description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter.",
"nullable": true,
"type": "boolean"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. You can use the unique name in the URL path. Unique up to 64 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.assistant_fallback_actions": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"data": {
"nullable": true
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.assistant_initiation_actions": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"data": {
"nullable": true
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.dialogue": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"data": {
"description": "The dialogue memory object as json",
"nullable": true
},
"sid": {
"description": "The unique ID of the Dialogue",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UK[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.field_type": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field Type.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UB[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.field_type.field_value": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field Value.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"field_type_sid": {
"description": "The unique ID of the Field Type associated with this Field Value.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UB[0-9a-fA-F]{32}$",
"type": "string"
},
"language": {
"description": "An ISO language-country string of the value.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UC[0-9a-fA-F]{32}$",
"type": "string"
},
"synonym_of": {
"description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UC[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"value": {
"description": "The Field Value itself.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.model_build": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Model Build.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"build_duration": {
"description": "The time in seconds it took to build the model.",
"nullable": true,
"type": "integer"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"error_code": {
"nullable": true,
"type": "integer"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UG[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/model_build_enum_status",
"description": "A string that described the model build status. The values can be: enqueued, building, completed, failed",
"nullable": true,
"type": "string"
},
"unique_name": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.query": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Query.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"language": {
"description": "An ISO language-country string of the sample.",
"nullable": true,
"type": "string"
},
"model_build_sid": {
"description": "The unique ID of the Model Build queried.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UG[0-9a-fA-F]{32}$",
"type": "string"
},
"query": {
"description": "The end-user's natural language input.",
"nullable": true,
"type": "string"
},
"results": {
"description": "The natural language analysis results which include the Task recognized, the confidence score and a list of identified Fields.",
"nullable": true
},
"sample_sid": {
"description": "An optional reference to the Sample created from this query.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UH[0-9a-fA-F]{32}$",
"type": "string"
},
"source_channel": {
"description": "The communication channel where this end-user input came from",
"nullable": true,
"type": "string"
},
"status": {
"description": "A string that described the query status. The values can be: pending_review, reviewed, discarded",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.style_sheet": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Assistant",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the Assistant",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"data": {
"description": "The JSON style sheet object",
"nullable": true
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.task": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Task.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"actions_url": {
"description": "User-provided HTTP endpoint where from the assistant fetches actions",
"format": "uri",
"nullable": true,
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.",
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UD[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.task.field": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"field_type": {
"description": "The Field Type of this field. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or sid of a custom Field Type.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UE[0-9a-fA-F]{32}$",
"type": "string"
},
"task_sid": {
"description": "The unique ID of the Task associated with this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UD[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.",
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.task.sample": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Sample.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"description": "The date that this resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"description": "The date that this resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"language": {
"description": "An ISO language-country string of the sample.",
"nullable": true,
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this resource.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UF[0-9a-fA-F]{32}$",
"type": "string"
},
"source_channel": {
"description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null",
"nullable": true,
"type": "string"
},
"tagged_text": {
"description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.",
"nullable": true,
"type": "string"
},
"task_sid": {
"description": "The unique ID of the Task associated with this Sample.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UD[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.task.task_actions": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"data": {
"nullable": true
},
"task_sid": {
"description": "The unique ID of the Task.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UD[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.understand.assistant.task.task_statistics": {
"properties": {
"account_sid": {
"description": "The unique ID of the Account that created this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"assistant_sid": {
"description": "The unique ID of the parent Assistant.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UA[0-9a-fA-F]{32}$",
"type": "string"
},
"fields_count": {
"description": "The total number of Fields associated with this Task.",
"nullable": true,
"type": "integer"
},
"samples_count": {
"description": "The total number of Samples associated with this Task.",
"nullable": true,
"type": "integer"
},
"task_sid": {
"description": "The unique ID of the Task associated with this Field.",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^UD[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.wireless.command": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"command": {
"nullable": true,
"type": "string"
},
"command_mode": {
"nullable": true,
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"device_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DE[0-9a-fA-F]{32}$",
"type": "string"
},
"direction": {
"nullable": true,
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DC[0-9a-fA-F]{32}$",
"type": "string"
},
"sim_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DE[0-9a-fA-F]{32}$",
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.wireless.rate_plan": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"data_enabled": {
"nullable": true,
"type": "boolean"
},
"data_limit": {
"nullable": true,
"type": "integer"
},
"data_metering": {
"nullable": true,
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"nullable": true,
"type": "string"
},
"international_roaming": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"messaging_enabled": {
"nullable": true,
"type": "boolean"
},
"national_roaming_enabled": {
"nullable": true,
"type": "boolean"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^WP[0-9a-fA-F]{32}$",
"type": "string"
},
"unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"voice_enabled": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"preview.wireless.sim": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"commands_callback_method": {
"nullable": true,
"type": "string"
},
"commands_callback_url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"date_created": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"e_id": {
"nullable": true,
"type": "string"
},
"friendly_name": {
"nullable": true,
"type": "string"
},
"iccid": {
"nullable": true,
"type": "string"
},
"links": {
"format": "uri-map",
"nullable": true,
"type": "object"
},
"rate_plan_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^WP[0-9a-fA-F]{32}$",
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DE[0-9a-fA-F]{32}$",
"type": "string"
},
"sms_fallback_method": {
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"nullable": true,
"type": "string"
},
"sms_fallback_url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"sms_method": {
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"nullable": true,
"type": "string"
},
"sms_url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"voice_fallback_method": {
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"nullable": true,
"type": "string"
},
"voice_fallback_url": {
"format": "uri",
"nullable": true,
"type": "string"
},
"voice_method": {
"enum": [
"HEAD",
"GET",
"POST",
"PATCH",
"PUT",
"DELETE"
],
"format": "http-method",
"nullable": true,
"type": "string"
},
"voice_url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"preview.wireless.sim.usage": {
"properties": {
"account_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"commands_costs": {
"nullable": true
},
"commands_usage": {
"nullable": true
},
"data_costs": {
"nullable": true
},
"data_usage": {
"nullable": true
},
"period": {
"nullable": true
},
"sim_sid": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^DE[0-9a-fA-F]{32}$",
"type": "string"
},
"sim_unique_name": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"sync_list_item_enum_query_from_bound_type": {
"enum": [
"inclusive",
"exclusive"
],
"type": "string"
},
"sync_list_item_enum_query_result_order": {
"enum": [
"asc",
"desc"
],
"type": "string"
},
"sync_map_item_enum_query_from_bound_type": {
"enum": [
"inclusive",
"exclusive"
],
"type": "string"
},
"sync_map_item_enum_query_result_order": {
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
"securitySchemes": {
"accountSid_authToken": {
"scheme": "basic",
"type": "http"
}
}
},
"x-maturity": [
{
"description": "PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com.",
"name": "Preview"
}
]
}