{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "intelligence.v2.custom_operator": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account the Custom Operator belongs to." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Custom Operator." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human-readable name of this resource, up to 64 characters." }, "description": { "type": "string", "nullable": true, "description": "A human-readable description of this resource, longer than the friendly name." }, "author": { "type": "string", "nullable": true, "description": "The creator of the Custom Operator. Custom Operators can only be created by a Twilio Account." }, "operator_type": { "type": "string", "nullable": true, "description": "Operator Type for this Operator. References an existing Operator Type resource." }, "version": { "type": "integer", "default": 0, "description": "Numeric Custom Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Custom Operator." }, "availability": { "$ref": "#/components/schemas/custom_operator_enum_availability" }, "config": { "nullable": true, "description": "Operator configuration, following the schema defined by the Operator Type. Only available on Operators created by the Account." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Custom Operator was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Custom Operator was updated, given in ISO 8601 format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "custom_operator_enum_availability": { "type": "string", "enum": [ "internal", "beta", "public", "retired", "general-availability", "deprecated" ], "description": "Custom Operator availability status. Possible values: internal, beta, public, retired." }, "intelligence.v2.transcript.encrypted_operator_results": { "type": "object", "properties": { "locations": { "type": "array", "items": { "type": "string", "format": "uri" }, "nullable": true, "description": "The locations of the encrypted operator results." }, "transcript_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "intelligence.v2.transcript.encrypted_sentences": { "type": "object", "properties": { "location": { "type": "string", "format": "uri", "nullable": true, "description": "The location of the encrypted sentences." }, "transcript_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$", "nullable": true }, "url": { "type": "string", "format": "uri", "nullable": true } } }, "intelligence.v2.transcript.media": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account." }, "media_url": { "type": "string", "format": "uri", "nullable": true, "description": "Downloadable URL for media, if stored in Twilio AI." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Service." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Transcript." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "intelligence.v2.operator": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account the Operator belongs to." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Operator." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human-readable name of this resource, up to 64 characters." }, "description": { "type": "string", "nullable": true, "description": "A human-readable description of this resource, longer than the friendly name." }, "author": { "type": "string", "nullable": true, "description": "The creator of the Operator. Either Twilio or the creating Account." }, "operator_type": { "type": "string", "nullable": true, "description": "Operator Type for this Operator. References an existing Operator Type resource." }, "version": { "type": "integer", "default": 0, "description": "Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator." }, "availability": { "$ref": "#/components/schemas/operator_enum_availability" }, "config": { "nullable": true, "description": "Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Operator was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Operator was updated, given in ISO 8601 format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "operator_enum_availability": { "type": "string", "enum": [ "internal", "beta", "public", "deprecated", "general-availability", "retired" ], "description": "Operator availability status. Possible values: internal, beta, public, retired." }, "intelligence.v2.operator_attachment": { "type": "object", "properties": { "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Service." }, "operator_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Operator." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "intelligence.v2.operator_attachments": { "type": "object", "properties": { "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Service." }, "operator_sids": { "type": "array", "items": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "nullable": true, "description": "List of Operator SIDs attached to the service. Includes both Custom and Pre-built Operators." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "intelligence.v2.transcript.operator_result": { "type": "object", "properties": { "operator_type": { "$ref": "#/components/schemas/operator_result_enum_operator_type" }, "name": { "type": "string", "nullable": true, "description": "The name of the applied Language Understanding." }, "operator_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that identifies this Language Understanding operator sid." }, "extract_match": { "type": "boolean", "nullable": true, "description": "Boolean to tell if extract Language Understanding Processing model matches results." }, "match_probability": { "type": "number", "nullable": true, "description": "Percentage of 'matching' class needed to consider a sentence matches" }, "normalized_result": { "type": "string", "nullable": true, "description": "Normalized output of extraction stage which matches Label." }, "utterance_results": { "type": "array", "items": {}, "nullable": true, "description": "List of mapped utterance object which matches sentences." }, "utterance_match": { "type": "boolean", "nullable": true, "description": "Boolean to tell if Utterance matches results." }, "predicted_label": { "type": "string", "nullable": true, "description": "The 'matching' class. This might be available on conversation classify model outputs." }, "predicted_probability": { "type": "number", "nullable": true, "description": "Percentage of 'matching' class needed to consider a sentence matches." }, "label_probabilities": { "nullable": true, "description": "The labels probabilities. This might be available on conversation classify model outputs." }, "extract_results": { "nullable": true, "description": "List of text extraction results. This might be available on classify-extract model outputs." }, "text_generation_results": { "nullable": true, "description": "Output of a text generation operator for example Conversation Sumamary." }, "json_results": { "nullable": true }, "transcript_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Transcript." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "operator_result_enum_operator_type": { "type": "string", "enum": [ "conversation-classify", "utterance-classify", "extract", "extract-normalize", "pii-extract", "text-generation", "json" ], "description": "The type of the applied Language Understanding Operator. One of conversation-classify, utterance-classify, extract, extract-normalize, or pii-extract" }, "intelligence.v2.operator_type": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "description": "A unique name that references an Operator's Operator Type." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^EY[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Operator Type." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human-readable name of this resource, up to 64 characters." }, "description": { "type": "string", "nullable": true, "description": "A human-readable description of this resource, longer than the friendly name." }, "docs_link": { "type": "string", "format": "uri", "nullable": true, "description": "Additional documentation for the Operator Type." }, "output_type": { "$ref": "#/components/schemas/operator_type_enum_output_type" }, "supported_languages": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of languages this Operator Type supports." }, "provider": { "$ref": "#/components/schemas/operator_type_enum_provider" }, "availability": { "$ref": "#/components/schemas/operator_type_enum_availability" }, "configurable": { "type": "boolean", "nullable": true, "description": "Operators can be created from configurable Operator Types." }, "config_schema": { "nullable": true, "description": "JSON Schema for configuring an Operator with this Operator Type. Following https://json-schema.org/" }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Operator Type was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Operator Type was updated, given in ISO 8601 format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "operator_type_enum_output_type": { "type": "string", "enum": [ "text-classification", "text-extraction", "text-extraction-normalized", "text-generation", "json" ], "description": "Operator Results for this Operator Type will follow this format. Possible values: text-classification, text-extraction, text-extraction-normalized, text-generation." }, "operator_type_enum_provider": { "type": "string", "enum": [ "twilio", "amazon", "openai" ], "description": "Operators with this Operator Type are executed using this provider. Possible values: twilio, amazon, openai." }, "operator_type_enum_availability": { "type": "string", "enum": [ "internal", "beta", "general-availability", "retired", "deprecated" ], "description": "Operator Type availability status. Possible values: internal, beta, general-availability, retired, deprecated." }, "intelligence.v2.prebuilt_operator": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account the Pre-built Operator belongs to." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Pre-built Operator." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human-readable name of this resource, up to 64 characters." }, "description": { "type": "string", "nullable": true, "description": "A human-readable description of this resource, longer than the friendly name." }, "author": { "type": "string", "nullable": true, "description": "The creator of the Operator. Pre-built Operators can only be created by Twilio." }, "operator_type": { "type": "string", "nullable": true, "description": "Operator Type for this Operator. References an existing Operator Type resource." }, "version": { "type": "integer", "default": 0, "description": "Numeric Operator version. Incremented with each update on the resource, used to ensure integrity when updating the Operator." }, "availability": { "$ref": "#/components/schemas/prebuilt_operator_enum_availability" }, "config": { "nullable": true, "description": "Operator configuration, following the schema defined by the Operator Type. Only available on Custom Operators created by the Account, will be empty for Pre-Built Operators." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Pre-built Operator was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Pre-built Operator was updated, given in ISO 8601 format." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." } } }, "prebuilt_operator_enum_availability": { "type": "string", "enum": [ "internal", "beta", "public", "retired", "general-availability" ], "description": "Operator availability status. Possible values: internal, beta, public, retired." }, "intelligence.v2.transcript.sentence": { "type": "object", "properties": { "media_channel": { "type": "integer", "default": 0, "description": "The channel number." }, "sentence_index": { "type": "integer", "default": 0, "description": "The index of the sentence in the transcript." }, "start_time": { "type": "string", "nullable": true, "description": "Offset from the beginning of the transcript when this sentence starts." }, "end_time": { "type": "string", "nullable": true, "description": "Offset from the beginning of the transcript when this sentence ends." }, "transcript": { "type": "string", "nullable": true, "description": "Transcript text.", "x-twilio": { "pii": { "handling": "sensitive", "deleteSla": 30 } } }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GX[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Sentence." }, "confidence": { "type": "string", "nullable": true }, "words": { "type": "array", "items": {}, "nullable": true, "description": "Detailed information for each of the words of the given Sentence." } } }, "intelligence.v2.service": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account the Service belongs to." }, "auto_redaction": { "type": "boolean", "nullable": true, "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service." }, "media_redaction": { "type": "boolean", "nullable": true, "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise." }, "auto_transcribe": { "type": "boolean", "nullable": true, "description": "Instructs the Speech Recognition service to automatically transcribe all recordings made on the account." }, "data_logging": { "type": "boolean", "nullable": true, "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Service was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Service was updated, given in ISO 8601 format." }, "friendly_name": { "type": "string", "nullable": true, "description": "A human readable description of this resource, up to 64 characters." }, "language_code": { "type": "string", "nullable": true, "description": "The language code set during Service creation determines the Transcription language for all call recordings processed by that Service. The default is en-US if no language code is set. A Service can only support one language code, and it cannot be updated once it's set." }, "sid": { "type": "string", "nullable": true, "description": "A 34 character string that uniquely identifies this Service." }, "unique_name": { "type": "string", "nullable": true, "description": "Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." }, "webhook_url": { "type": "string", "nullable": true, "description": "The URL Twilio will request when executing the Webhook." }, "webhook_http_method": { "$ref": "#/components/schemas/service_enum_http_method" }, "read_only_attached_operator_sids": { "type": "array", "items": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "nullable": true, "description": "Operator sids attached to this service, read only" }, "version": { "type": "integer", "default": 0, "description": "The version number of this Service." }, "encryption_credential_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results." } } }, "service_enum_http_method": { "type": "string", "enum": [ "GET", "POST", "NULL" ], "description": "The HTTP method for the Webhook. One of `GET` or `POST`." }, "intelligence.v2.transcript": { "type": "object", "properties": { "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Account." }, "service_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Service." }, "sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$", "nullable": true, "description": "A 34 character string that uniquely identifies this Transcript." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Transcript was created, given in ISO 8601 format." }, "date_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Transcript was updated, given in ISO 8601 format." }, "status": { "$ref": "#/components/schemas/transcript_enum_status" }, "channel": { "nullable": true, "description": "Media Channel describing Transcript Source and Participant Mapping" }, "data_logging": { "type": "boolean", "nullable": true, "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "language_code": { "type": "string", "nullable": true, "description": "The default language code of the audio." }, "customer_key": { "type": "string", "nullable": true }, "media_start_time": { "type": "string", "format": "date-time", "nullable": true, "description": "The date that this Transcript's media was started, given in ISO 8601 format." }, "duration": { "type": "integer", "default": 0, "description": "The duration of this Transcript's source" }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this resource." }, "redaction": { "type": "boolean", "nullable": true, "description": "If the transcript has been redacted, a redacted alternative of the transcript will be available." }, "encryption_credential_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "nullable": true, "description": "The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results." }, "links": { "type": "object", "format": "uri-map", "nullable": true } } }, "transcript_enum_status": { "type": "string", "enum": [ "queued", "in-progress", "completed", "new", "failed", "canceled", "error" ], "description": "The Status of this Transcript. One of `queued`, `in-progress`, `completed`, `failed` or `canceled`." }, "transcript_enum_call_direction": { "type": "string", "enum": [ "inbound", "outbound", "internal", "unknown" ] } } }, "info": { "title": "Twilio - Intelligence", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0", "x-twilio": { "apiStandards": "v0.1" } }, "openapi": "3.0.1", "paths": { "/v2/Operators/Custom": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "custom_operators", "pathType": "list" }, "post": { "description": "Create a new Custom Operator for the given Account", "summary": "Create a new Custom Operator for the given Account", "tags": [ "IntelligenceV2CustomOperator" ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateCustomOperator", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateCustomOperatorRequest", "properties": { "FriendlyName": { "type": "string", "description": "A human readable description of the new Operator, up to 64 characters." }, "OperatorType": { "type": "string", "description": "Operator Type for this Operator. References an existing Operator Type resource." }, "Config": { "description": "Operator configuration, following the schema defined by the Operator Type." } }, "required": [ "FriendlyName", "OperatorType", "Config" ] }, "examples": { "create": { "value": { "FriendlyName": "My New Operator", "Config": "{ \"configuration\" : { \"field\": \"value\"}}", "OperatorType": "operator-type-name" } } } } } } }, "get": { "description": "Retrieves a list of all Custom Operators for an Account.", "summary": "Retrieves a list of all Custom Operators for an Account.", "tags": [ "IntelligenceV2CustomOperator" ], "parameters": [ { "name": "Availability", "in": "query", "description": "Returns Custom Operators with the provided availability type. Possible values: internal, beta, public, retired.", "schema": { "$ref": "#/components/schemas/custom_operator_enum_availability" }, "examples": { "readFull": { "value": "public" }, "readEmpty": { "value": "public" } } }, { "name": "LanguageCode", "in": "query", "description": "Returns Custom Operators that support the provided language code.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "en" }, "readEmpty": { "value": "en" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operators": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" } }, "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": "ListCustomOperatorResponse" }, "examples": { "readFull": { "value": { "operators": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } }, "readEmpty": { "value": { "operators": [], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators/Custom?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListCustomOperator" } }, "/v2/Operators/Custom/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "custom_operators", "pathType": "instance" }, "post": { "description": "Update a specific Custom Operator.", "summary": "Update a specific Custom Operator.", "tags": [ "IntelligenceV2CustomOperator" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Custom Operator.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP request header", "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" }, "examples": { "update": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "My New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 2, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateCustomOperator", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateCustomOperatorRequest", "properties": { "FriendlyName": { "type": "string", "description": "A human-readable name of this resource, up to 64 characters." }, "Config": { "description": "Operator configuration, following the schema defined by the Operator Type." } }, "required": [ "FriendlyName", "Config" ] }, "examples": { "update": { "value": { "FriendlyName": "My New Operator", "Config": "{ \"configuration\" : { \"field\": \"value\"}}" } } } } } } }, "delete": { "description": "Delete a specific Custom Operator.", "summary": "Delete a specific Custom Operator.", "tags": [ "IntelligenceV2CustomOperator" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Custom Operator.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully.", "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } } } } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteCustomOperator" }, "get": { "description": "Fetch a specific Custom Operator.", "summary": "Fetch a specific Custom Operator.", "tags": [ "IntelligenceV2CustomOperator" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Custom Operator.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.custom_operator" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/Custom/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchCustomOperator" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults/Encrypted": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "locations" ], "parent": "/Transcripts/{Sid}", "mountName": "encrypted_operator_results", "className": "encrypted_operator_results", "pathType": "instance" }, "get": { "description": "Fetch Public Key Encrypted Operator Results by TranscriptSid", "summary": "Fetch Public Key Encrypted Operator Results by TranscriptSid", "tags": [ "IntelligenceV2EncryptedOperatorResults" ], "parameters": [ { "name": "TranscriptSid", "in": "path", "description": "The unique SID identifier of the Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII Redacted/Unredacted Operator Results. If redaction is enabled, the default is `true` to access redacted operator results.", "schema": { "type": "boolean" }, "examples": { "fetchRedacted": { "value": "True" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.encrypted_operator_results" }, "examples": { "fetch": { "value": { "locations": [ "https://com.twilio.us1.operatorresults.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults1", "https://com.twilio.us1.operatorresults.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults2" ], "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } }, "fetchRedacted": { "value": { "locations": [ "https://com.twilio.us1.operatorresults.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults1", "https://com.twilio.us1.operatorresults.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults2" ], "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchEncryptedOperatorResults" } }, "/v2/Transcripts/{TranscriptSid}/Sentences/Encrypted": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "location" ], "parent": "/Transcripts/{Sid}", "mountName": "encrypted_sentences", "className": "encrypted_sentences", "pathType": "instance" }, "get": { "description": "Fetch Public Key Encrypted Sentences by TranscriptSid", "summary": "Fetch Public Key Encrypted Sentences by TranscriptSid", "tags": [ "IntelligenceV2EncryptedSentences" ], "parameters": [ { "name": "TranscriptSid", "in": "path", "description": "The unique SID identifier of the Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.", "schema": { "type": "boolean" }, "examples": { "fetchRedacted": { "value": "True" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.encrypted_sentences" }, "examples": { "fetch": { "value": { "location": "https://com.twilio.us1.sentences.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted" } }, "fetchRedacted": { "value": { "location": "https://com.twilio.us1.sentences.s3.amazonaws.com/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchEncryptedSentences" } }, "/v2/Transcripts/{Sid}/Media": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "account_sid", "service_sid", "sid" ], "parent": "/Transcripts/{Sid}", "pathType": "instance" }, "get": { "description": "Get download URLs for media if possible", "summary": "Get download URLs for media if possible", "tags": [ "IntelligenceV2Media" ], "parameters": [ { "name": "Sid", "in": "path", "description": "The unique SID identifier of the Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII Redacted/Unredacted Media. If redaction is enabled, the default is `true` to access redacted media.", "schema": { "type": "boolean" }, "examples": { "fetchParams": { "value": "True" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.media" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "media_url": "https://media.server.com/media.wav", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } }, "fetchParams": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "media_url": "https://media.server.com/media.wav", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media" } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchMedia" } }, "/v2/Operators/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "pathType": "instance" }, "get": { "description": "Fetch a specific Operator. Works for both Custom and Pre-built Operators.", "summary": "Fetch a specific Operator. Works for both Custom and Pre-built Operators.", "tags": [ "IntelligenceV2Operator" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Operator.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchOperator" } }, "/v2/Operators": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "pathType": "list" }, "get": { "description": "Retrieves a list of all Operators for an Account, both Custom and Pre-built.", "summary": "Retrieves a list of all Operators for an Account, both Custom and Pre-built.", "tags": [ "IntelligenceV2Operator" ], "parameters": [ { "name": "Availability", "in": "query", "description": "Returns Operators with the provided availability type. Possible values: internal, beta, public, retired.", "schema": { "$ref": "#/components/schemas/operator_enum_availability" }, "examples": { "readFull": { "value": "public" }, "readEmpty": { "value": "public" } } }, { "name": "LanguageCode", "in": "query", "description": "Returns Operators that support the provided language code.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "en" }, "readEmpty": { "value": "en" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operators": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.operator" } }, "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": "ListOperatorResponse" }, "examples": { "readFull": { "value": { "operators": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } }, "readEmpty": { "value": { "operators": [], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListOperator" } }, "/v2/Services/{ServiceSid}/Operators/{OperatorSid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "service_sid", "operator_sid" ], "mountName": "operator_attachment", "pathType": "instance" }, "post": { "description": "Attach an Operator to a Service.", "summary": "Attach an Operator to a Service.", "tags": [ "IntelligenceV2OperatorAttachment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Service.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" }, "required": true }, { "name": "OperatorSid", "in": "path", "description": "The unique SID identifier of the Operator. Allows both Custom and Pre-built Operators.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_attachment" }, "examples": { "create": { "value": { "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Operators/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateOperatorAttachment" }, "delete": { "description": "Detach an Operator from a Service.", "summary": "Detach an Operator from a Service.", "tags": [ "IntelligenceV2OperatorAttachment" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Service.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" }, "required": true }, { "name": "OperatorSid", "in": "path", "description": "The unique SID identifier of the Operator. Allows both Custom and Pre-built Operators.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteOperatorAttachment" } }, "/v2/Services/{ServiceSid}/Operators": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sids" ], "mountName": "operator_attachments", "className": "operator_attachments", "pathType": "instance" }, "get": { "description": "Retrieve Operators attached to a Service.", "summary": "Retrieve Operators attached to a Service.", "tags": [ "IntelligenceV2OperatorAttachments" ], "parameters": [ { "name": "ServiceSid", "in": "path", "description": "The unique SID identifier of the Service.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_attachments" }, "examples": { "fetch": { "value": { "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_sids": [ "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab" ], "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Operators" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchOperatorAttachments" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sid" ], "parent": "/Transcripts/{Sid}", "pathType": "list" }, "get": { "description": "Retrieve a list of Operator Results for the given Transcript.", "summary": "Retrieve a list of Operator Results for the given Transcript.", "tags": [ "IntelligenceV2OperatorResult" ], "parameters": [ { "name": "TranscriptSid", "in": "path", "description": "A 34 character string that uniquely identifies this Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.", "schema": { "type": "boolean" }, "examples": { "readFull": { "value": "True" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operator_results": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.transcript.operator_result" } }, "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": "ListOperatorResultResponse" }, "examples": { "readEmpty": { "value": { "operator_results": [], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0", "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?PageSize=50&Page=0", "next_page_url": null, "key": "operator_results" } } }, "readFull": { "value": { "operator_results": [ { "operator_type": "conversation-classify", "name": "name", "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "extract_match": false, "match_probability": "0.05", "normalized_result": "normalized_result", "utterance_results": [ {} ], "utterance_match": false, "predicted_label": "predicted_label", "predicted_probability": "0.05", "label_probabilities": {}, "extract_results": {}, "text_generation_results": {}, "json_results": {}, "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=true&PageSize=50&Page=0", "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults?Redacted=true&PageSize=50&Page=0", "next_page_url": null, "key": "operator_results" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListOperatorResult" } }, "/v2/Transcripts/{TranscriptSid}/OperatorResults/{OperatorSid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "operator_sid" ], "parent": "/Transcripts/{Sid}", "pathType": "instance" }, "get": { "description": "Fetch a specific Operator Result for the given Transcript.", "summary": "Fetch a specific Operator Result for the given Transcript.", "tags": [ "IntelligenceV2OperatorResult" ], "parameters": [ { "name": "TranscriptSid", "in": "path", "description": "A 34 character string that uniquely identifies this Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "OperatorSid", "in": "path", "description": "A 34 character string that identifies this Language Understanding operator sid.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII redacted/unredacted Language Understanding operator. If redaction is enabled, the default is True.", "schema": { "type": "boolean" }, "examples": { "fetch": { "value": "False" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript.operator_result" }, "examples": { "fetch": { "value": { "operator_type": "conversation-classify", "name": "name", "operator_sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "extract_match": false, "match_probability": "0.05", "normalized_result": "normalized_result", "utterance_results": [ {} ], "utterance_match": false, "predicted_label": "predicted_label", "predicted_probability": "0.05", "label_probabilities": {}, "extract_results": {}, "text_generation_results": {}, "json_results": {}, "transcript_sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchOperatorResult" } }, "/v2/OperatorTypes": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "operator_type", "pathType": "list" }, "get": { "description": "Retrieves a list of all Operator Types for an Account.", "summary": "Retrieves a list of all Operator Types for an Account.", "tags": [ "IntelligenceV2OperatorType" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } }, { "name": "LanguageCode", "in": "query", "description": "Returns Operator Types that support the provided language code.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "en" }, "readEmpty": { "value": "en" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operator_types": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.operator_type" } }, "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": "ListOperatorTypeResponse" }, "examples": { "readFull": { "value": { "operator_types": [ { "name": "Summarization", "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Summarize Conversations", "description": "Summarize Conversations", "docs_link": "https://www.twilio.com/docs/conversational-intelligence/key-concepts#language-operators", "output_type": "text-generation", "supported_languages": [ "en" ], "provider": "openai", "availability": "general-availability", "configurable": true, "config_schema": { "field": "value" }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0", "key": "operator_types", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0" } } }, "readEmpty": { "value": { "operator_types": [], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0", "key": "operator_types", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/OperatorTypes?PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListOperatorType" } }, "/v2/OperatorTypes/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "operator_type", "pathType": "instance" }, "get": { "description": "Fetch a specific Operator Type.", "summary": "Fetch a specific Operator Type.", "tags": [ "IntelligenceV2OperatorType" ], "parameters": [ { "name": "Sid", "in": "path", "description": "Either a 34 character string that uniquely identifies this Operator Type or the unique name that references an Operator Type.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.operator_type" }, "examples": { "fetch": { "value": { "name": "Summarization", "sid": "EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "Summarize Conversations", "description": "Summarize Conversations", "docs_link": "https://www.twilio.com/docs/conversational-intelligence/key-concepts#language-operators", "output_type": "text-generation", "supported_languages": [ "en" ], "provider": "openai", "availability": "general-availability", "configurable": true, "config_schema": { "field": "value" }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/OperatorTypes/EYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchOperatorType" } }, "/v2/Operators/PreBuilt/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "prebuilt_operators", "pathType": "instance" }, "get": { "description": "Fetch a specific Pre-built Operator.", "summary": "Fetch a specific Pre-built Operator.", "tags": [ "IntelligenceV2PrebuiltOperator" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Pre-built Operator.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^LY[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.prebuilt_operator" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchPrebuiltOperator" } }, "/v2/Operators/PreBuilt": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid" ], "mountName": "prebuilt_operators", "pathType": "list" }, "get": { "description": "Retrieves a list of all Pre-built Operators for an account.", "summary": "Retrieves a list of all Pre-built Operators for an account.", "tags": [ "IntelligenceV2PrebuiltOperator" ], "parameters": [ { "name": "Availability", "in": "query", "description": "Returns Pre-built Operators with the provided availability type. Possible values: internal, beta, public, retired.", "schema": { "$ref": "#/components/schemas/prebuilt_operator_enum_availability" }, "examples": { "readFull": { "value": "public" }, "readEmpty": { "value": "public" } } }, { "name": "LanguageCode", "in": "query", "description": "Returns Pre-built Operators that support the provided language code.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "en" }, "readEmpty": { "value": "en" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "operators": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.prebuilt_operator" } }, "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": "ListPrebuiltOperatorResponse" }, "examples": { "readFull": { "value": { "operators": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "friendly_name": "My New Operator", "description": "New Operator", "author": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "operator_type": "operator-type-name", "version": 1, "availability": "public", "config": { "configuration": { "field": "value" } }, "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt/LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } }, "readEmpty": { "value": { "operators": [], "meta": { "first_page_url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0", "key": "operators", "next_page_url": null, "page": 0, "page_size": 50, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Operators/PreBuilt?LanguageCode=en&Availability=public&PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListPrebuiltOperator" } }, "/v2/Transcripts/{TranscriptSid}/Sentences": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "media_channel", "sentence_index", "transcript", "start_time", "end_time", "confidence", "words" ], "parent": "/Transcripts/{Sid}", "pathType": "list" }, "get": { "description": "Get all Transcript Sentences by TranscriptSid", "summary": "Get all Transcript Sentences by TranscriptSid", "tags": [ "IntelligenceV2Sentence" ], "parameters": [ { "name": "TranscriptSid", "in": "path", "description": "The unique SID identifier of the Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true }, { "name": "Redacted", "in": "query", "description": "Grant access to PII Redacted/Unredacted Sentences. If redaction is enabled, the default is `true` to access redacted sentences.", "schema": { "type": "boolean" }, "examples": { "readParams": { "value": "True" } } }, { "name": "WordTimestamps", "in": "query", "description": "Returns word level timestamps information, if word_timestamps is enabled. The default is `false`.", "schema": { "type": "boolean" }, "examples": { "readParams": { "value": "True" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 5000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 5000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sentences": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.transcript.sentence" } }, "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": "ListSentenceResponse" }, "examples": { "readFull": { "value": { "sentences": [ { "media_channel": 1, "sentence_index": 0, "start_time": null, "end_time": null, "transcript": "test test", "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "confidence": null, "words": [ { "word": "test", "start_time": null, "end_time": null }, { "word": "test", "start_time": null, "end_time": null } ] } ], "meta": { "key": "sentences", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null } } }, "readParams": { "value": { "sentences": [ { "media_channel": 1, "sentence_index": 0, "start_time": null, "end_time": null, "transcript": "test test", "sid": "GXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "confidence": null, "words": [ { "word": "test", "start_time": null, "end_time": null }, { "word": "test", "start_time": null, "end_time": null } ] } ], "meta": { "key": "sentences", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=true&WordTimestamps=true&PageSize=50&Page=0", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences?Redacted=true&WordTimestamps=true&PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListSentence" } }, "/v2/Services": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name", "language_code", "date_created", "version" ], "pathType": "list" }, "post": { "description": "Create a new Service for the given Account", "summary": "Create a new Service for the given Account", "tags": [ "IntelligenceV2Service" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" }, "examples": { "create": { "value": { "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "something", "friendly_name": "some friendly name", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "auto_redaction": false, "media_redaction": false, "auto_transcribe": true, "data_logging": true, "language_code": "en-US", "webhook_url": "https://www.twilio.com", "webhook_http_method": "POST", "read_only_attached_operator_sids": [ "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "version": 1, "encryption_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateServiceRequest", "properties": { "UniqueName": { "type": "string", "description": "Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID." }, "AutoTranscribe": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically transcribe all recordings made on the account." }, "DataLogging": { "type": "boolean", "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", "description": "A human readable description of this resource, up to 64 characters." }, "LanguageCode": { "type": "string", "description": "The language code set during Service creation determines the Transcription language for all call recordings processed by that Service. The default is en-US if no language code is set. A Service can only support one language code, and it cannot be updated once it's set." }, "AutoRedaction": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service." }, "MediaRedaction": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise." }, "WebhookUrl": { "type": "string", "description": "The URL Twilio will request when executing the Webhook." }, "WebhookHttpMethod": { "$ref": "#/components/schemas/service_enum_http_method" }, "EncryptionCredentialSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results." } }, "required": [ "UniqueName" ] }, "examples": { "create": { "value": { "UniqueName": "something", "FriendlyName": "some friendly name", "LanguageCode": "en-US", "WebhookUrl": "https://www.twilio.com", "WebhookHttpMethod": "POST", "EncryptionCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } } }, "get": { "description": "Retrieves a list of all Services for an account.", "summary": "Retrieves a list of all Services for an account.", "tags": [ "IntelligenceV2Service" ], "parameters": [ { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.service" } }, "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": "ListServiceResponse" }, "examples": { "readFull": { "value": { "services": [ { "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "something", "friendly_name": "some friendly name", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "auto_redaction": false, "media_redaction": false, "auto_transcribe": true, "data_logging": true, "language_code": "en-US", "webhook_url": "https://www.twilio.com", "webhook_http_method": "POST", "read_only_attached_operator_sids": [ "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "encryption_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "version": 1, "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } ], "meta": { "key": "services", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" } } }, "readEmpty": { "value": { "services": [], "meta": { "key": "services", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Services?PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListService" } }, "/v2/Services/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "unique_name", "friendly_name", "language_code", "date_created", "version" ], "pathType": "instance" }, "delete": { "description": "Delete a specific Service.", "summary": "Delete a specific Service.", "tags": [ "IntelligenceV2Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Service.", "schema": { "type": "string" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully.", "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } } } } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteService" }, "get": { "description": "Fetch a specific Service.", "summary": "Fetch a specific Service.", "tags": [ "IntelligenceV2Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Service.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" }, "examples": { "fetch": { "value": { "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "something", "friendly_name": "some friendly name", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "auto_redaction": false, "media_redaction": false, "auto_transcribe": true, "data_logging": true, "language_code": "en-US", "webhook_url": "https://www.twilio.com", "webhook_http_method": "POST", "read_only_attached_operator_sids": [ "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "encryption_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "version": 1, "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchService" }, "post": { "description": "Update a specific Service.", "summary": "Update a specific Service.", "tags": [ "IntelligenceV2Service" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Service.", "schema": { "type": "string" }, "required": true }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP request header", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.service" }, "examples": { "update": { "value": { "sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "unique_name": "something", "friendly_name": "some friendly name", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "auto_redaction": false, "media_redaction": false, "auto_transcribe": true, "data_logging": true, "webhook_url": "https://www.sendgrid.com", "webhook_http_method": "GET", "language_code": "en-US", "read_only_attached_operator_sids": [ "LYaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "version": 2, "encryption_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://intelligence.twilio.com/v2/Services/GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "ETag": { "schema": { "type": "string" } }, "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "UpdateService", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "UpdateServiceRequest", "properties": { "AutoTranscribe": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically transcribe all recordings made on the account." }, "DataLogging": { "type": "boolean", "description": "Data logging allows Twilio to improve the quality of the speech recognition & language understanding services through using customer data to refine, fine tune and evaluate machine learning models.\nNote: Data logging cannot be activated via API, only via www.twilio.com, as it requires additional consent." }, "FriendlyName": { "type": "string", "description": "A human readable description of this resource, up to 64 characters." }, "UniqueName": { "type": "string", "description": "Provides a unique and addressable name to be assigned to this Service, assigned by the developer, to be optionally used in addition to SID." }, "AutoRedaction": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts made on this service." }, "MediaRedaction": { "type": "boolean", "description": "Instructs the Speech Recognition service to automatically redact PII from all transcripts media made on this service. The auto_redaction flag must be enabled, results in error otherwise." }, "WebhookUrl": { "type": "string", "description": "The URL Twilio will request when executing the Webhook." }, "WebhookHttpMethod": { "$ref": "#/components/schemas/service_enum_http_method" }, "EncryptionCredentialSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^CR[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Public Key resource used to encrypt the sentences and operator results." } } }, "examples": { "update": { "value": { "UniqueName": "something", "FriendlyName": "some friendly name", "WebhookUrl": "https://www.sendgrid.com", "WebhookHttpMethod": "GET", "EncryptionCredentialSid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } } } } }, "/v2/Transcripts": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "media_start_time", "duration", "status" ], "dependentProperties": { "sentences": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences" }, "encrypted_sentences": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences/Encrypted" }, "media": { "mapping": { "sid": "sid" }, "resource_url": "/v2/Transcripts/{sid}/Media" }, "operator_results": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" }, "encrypted_operator_results": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults/Encrypted" } }, "pathType": "list" }, "post": { "description": "Create a new Transcript for the service", "summary": "Create a new Transcript for the service", "tags": [ "IntelligenceV2Transcript" ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript" }, "examples": { "create": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "status": "queued", "channel": { "media_properties": { "media_url": "http://foobar.test/ClusterTests/call1.wav" } }, "data_logging": false, "language_code": "en-US", "media_start_time": null, "duration": 0, "customer_key": "aaaaaaaa", "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "redaction": true, "encryption_credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "links": { "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", "encrypted_sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted", "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults", "encrypted_operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } }, "createParams": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "status": "queued", "channel": { "media_properties": { "media_url": "http://foobar.test/ClusterTests/call1.wav" } }, "data_logging": false, "language_code": "en-US", "media_start_time": null, "duration": 0, "customer_key": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "redaction": true, "encryption_credential_sid": null, "links": { "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", "encrypted_sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted", "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults", "encrypted_operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateTranscript", "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "title": "CreateTranscriptRequest", "properties": { "ServiceSid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$", "description": "The unique SID identifier of the Service." }, "Channel": { "description": "JSON object describing Media Channel including Source and Participants" }, "CustomerKey": { "type": "string", "description": "Used to store client provided metadata. Maximum of 64 double-byte UTF8 characters." }, "MediaStartTime": { "type": "string", "format": "date-time", "description": "The date that this Transcript's media was started, given in ISO 8601 format." } }, "required": [ "ServiceSid", "Channel" ] }, "examples": { "create": { "value": { "ServiceSid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Channel": "{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", "CustomerKey": "aaaaaaaa" } }, "createParams": { "value": { "ServiceSid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "Channel": "{ \"media_properties\" : { \"media_url\": \"http://foobar.test/ClusterTests/call1.wav\"}}", "CustomerKey": "aaaaaaaa" } } } } } } }, "get": { "description": "Retrieve a list of Transcripts for a given service.", "summary": "Retrieve a list of Transcripts for a given service.", "tags": [ "IntelligenceV2Transcript" ], "parameters": [ { "name": "ServiceSid", "in": "query", "description": "The unique SID identifier of the Service.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GA[0-9a-fA-F]{32}$" }, "examples": { "readFull": { "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "readEmpty": { "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "readQuery": { "value": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "BeforeStartTime", "in": "query", "description": "Filter by before StartTime.", "schema": { "type": "string" } }, { "name": "AfterStartTime", "in": "query", "description": "Filter by after StartTime.", "schema": { "type": "string" } }, { "name": "BeforeDateCreated", "in": "query", "description": "Filter by before DateCreated.", "schema": { "type": "string" } }, { "name": "AfterDateCreated", "in": "query", "description": "Filter by after DateCreated.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "2019-11-22T23:46:00Z" } } }, { "name": "Status", "in": "query", "description": "Filter by status.", "schema": { "type": "string" } }, { "name": "LanguageCode", "in": "query", "description": "Filter by Language Code.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "en-US" } } }, { "name": "SourceSid", "in": "query", "description": "Filter by SourceSid.", "schema": { "type": "string" }, "examples": { "readFull": { "value": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } }, { "name": "PageSize", "in": "query", "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 1000 } }, { "name": "Page", "in": "query", "description": "The page index. This value is simply for client state.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "PageToken", "in": "query", "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "transcripts": { "type": "array", "items": { "$ref": "#/components/schemas/intelligence.v2.transcript" } }, "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": "ListTranscriptResponse" }, "examples": { "readFull": { "value": { "transcripts": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "status": "queued", "channel": {}, "data_logging": false, "language_code": "en-US", "media_start_time": null, "duration": 0, "customer_key": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "redaction": true, "encryption_credential_sid": null, "links": { "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", "encrypted_sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted", "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults", "encrypted_operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } ], "meta": { "key": "transcripts", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Transcripts?LanguageCode=en-US&SourceSid=REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&AfterDateCreated=2019-11-22T23%3A46%3A00Z&PageSize=50&Page=0" } } }, "readEmpty": { "value": { "transcripts": [], "meta": { "key": "transcripts", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } }, "readQuery": { "value": { "transcripts": [ { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "status": "queued", "channel": {}, "data_logging": false, "language_code": "en-US", "media_start_time": null, "duration": 0, "customer_key": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "redaction": true, "encryption_credential_sid": null, "links": { "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", "encrypted_sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted", "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults", "encrypted_operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } ], "meta": { "key": "transcripts", "page": 0, "page_size": 50, "first_page_url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0", "next_page_url": null, "previous_page_url": null, "url": "https://intelligence.twilio.com/v2/Transcripts?ServiceSid=GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&PageSize=50&Page=0" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "ListTranscript" } }, "/v2/Transcripts/{Sid}": { "servers": [ { "url": "https://intelligence.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "sid", "date_created", "media_start_time", "duration", "status" ], "dependentProperties": { "sentences": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences" }, "encrypted_sentences": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/Sentences/Encrypted" }, "media": { "mapping": { "sid": "sid" }, "resource_url": "/v2/Transcripts/{sid}/Media" }, "operator_results": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults" }, "encrypted_operator_results": { "mapping": { "transcript_sid": "sid" }, "resource_url": "/v2/Transcripts/{transcript_sid}/OperatorResults/Encrypted" } }, "pathType": "instance" }, "get": { "description": "Fetch a specific Transcript.", "summary": "Fetch a specific Transcript.", "tags": [ "IntelligenceV2Transcript" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/intelligence.v2.transcript" }, "examples": { "fetch": { "value": { "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "service_sid": "GAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sid": "GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "date_created": "2010-08-31T20:36:28Z", "date_updated": "2010-08-31T20:36:28Z", "status": "queued", "channel": {}, "data_logging": false, "language_code": "en-US", "media_start_time": null, "duration": 0, "customer_key": null, "url": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "redaction": true, "encryption_credential_sid": null, "links": { "sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences", "encrypted_sentences": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sentences/Encrypted", "media": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media", "operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults", "encrypted_operator_results": "https://intelligence.twilio.com/v2/Transcripts/GTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/OperatorResults/Encrypted" } } } } } }, "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchTranscript" }, "delete": { "description": "Delete a specific Transcript.", "summary": "Delete a specific Transcript.", "tags": [ "IntelligenceV2Transcript" ], "parameters": [ { "name": "Sid", "in": "path", "description": "A 34 character string that uniquely identifies this Transcript.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^GT[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully.", "headers": { "X-Rate-Limit-Limit": { "schema": { "type": "string" } }, "X-Rate-Limit-Remaining": { "schema": { "type": "string" } }, "X-Rate-Limit-Config": { "schema": { "type": "string" } } } } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeleteTranscript" } } }, "servers": [ { "url": "https://intelligence.twilio.com" } ], "tags": [ { "name": "IntelligenceV2CustomOperator" }, { "name": "IntelligenceV2EncryptedOperatorResults" }, { "name": "IntelligenceV2EncryptedSentences" }, { "name": "IntelligenceV2Media" }, { "name": "IntelligenceV2Operator" }, { "name": "IntelligenceV2OperatorAttachment" }, { "name": "IntelligenceV2OperatorAttachments" }, { "name": "IntelligenceV2OperatorResult" }, { "name": "IntelligenceV2OperatorType" }, { "name": "IntelligenceV2PrebuiltOperator" }, { "name": "IntelligenceV2Sentence" }, { "name": "IntelligenceV2Service" }, { "name": "IntelligenceV2Transcript" }, { "name": "IntelligenceV2Version" } ], "security": [ { "accountSid_authToken": [] } ] }