Package-level declarations

Types

Link copied to clipboard
interface AnalysisPlan : AnalysisPlanProperties

This is the plan for analysis of assistant's calls. Stored in call.analysis.

Link copied to clipboard
interface ArtifactPlan : ArtifactPlanProperties

This is the plan for artifacts generated during assistant's calls. Stored in call.artifact.

Note: recordingEnabled is currently at the root level. It will be moved to artifactPlan in the future, but will remain backwards compatible.

Link copied to clipboard

This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead.

If you're unsure why you're getting an invalid assistant, try logging your response and send the JSON blob to POST /assistant which will return the validation errors.

Link copied to clipboard
Link copied to clipboard
interface AssistantId

This is the assistant that will be used for the call. To use a transient assistant, use assistant instead.

Link copied to clipboard
interface AssistantModels
Link copied to clipboard

These are the overrides for the assistant or assistantId's settings and template variables.

Link copied to clipboard
Link copied to clipboard
interface AssistantVoices
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface StructuredDataSchema : StructuredDataSchemaProperties
Link copied to clipboard
interface VoicemailDetection : VoicemailDetectionProperties

These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=VoicemailTool. This uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached. You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.