twilio
Version:
A Twilio helper library
1,232 lines • 93.6 kB
TypeScript
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
import { XMLElement } from "xmlbuilder";
import TwiML from "./TwiML";
declare class VoiceResponse extends TwiML {
/**
* <Response> TwiML for Voice
*/
constructor();
/**
* Comments in <Response>
*
* @param comment - XML Comment
*/
comment(comment: string): XMLElement;
/**
* Comments after <Response>
*
* @param comment - XML Comment
*/
commentAfter(comment: string): XMLElement;
/**
* Comments before <Response>
*
* @param comment - XML Comment
*/
commentBefore(comment: string): XMLElement;
/**
* <Connect> TwiML Verb
*
* @param attributes - TwiML attributes
*/
connect(attributes?: VoiceResponse.ConnectAttributes): VoiceResponse.Connect;
/**
* <Dial> TwiML Verb
*
* @param attributes - TwiML attributes
* @param number - Phone number to dial
*/
dial(number?: string): VoiceResponse.Dial;
dial(attributes?: VoiceResponse.DialAttributes, number?: string): VoiceResponse.Dial;
/**
* <Echo> TwiML Verb
*
* @param attributes - TwiML attributes
*/
echo(attributes?: object): VoiceResponse.Echo;
/**
* <Enqueue> TwiML Noun
*
* @param attributes - TwiML attributes
* @param name - Friendly name
*/
enqueue(name?: string): VoiceResponse.Enqueue;
enqueue(attributes?: VoiceResponse.EnqueueAttributes, name?: string): VoiceResponse.Enqueue;
/**
* <Gather> TwiML Verb
*
* @param attributes - TwiML attributes
*/
gather(attributes?: VoiceResponse.GatherAttributes): VoiceResponse.Gather;
/**
* <Hangup> TwiML Verb
*
* @param attributes - TwiML attributes
*/
hangup(attributes?: object): VoiceResponse.Hangup;
/**
* <Leave> TwiML Verb
*
* @param attributes - TwiML attributes
*/
leave(attributes?: object): VoiceResponse.Leave;
/**
* <Pause> TwiML Verb
*
* @param attributes - TwiML attributes
*/
pause(attributes?: VoiceResponse.PauseAttributes): VoiceResponse.Pause;
/**
* <Pay> Twiml Verb
*
* @param attributes - TwiML attributes
*/
pay(attributes?: VoiceResponse.PayAttributes): VoiceResponse.Pay;
/**
* <Play> TwiML Verb
*
* @param attributes - TwiML attributes
* @param url - Media URL
*/
play(url?: string): VoiceResponse.Play;
play(attributes?: VoiceResponse.PlayAttributes, url?: string): VoiceResponse.Play;
/**
* <Prompt> Twiml Verb
*
* @param attributes - TwiML attributes
*/
prompt(attributes?: VoiceResponse.PromptAttributes): VoiceResponse.Prompt;
/**
* <Queue> TwiML Noun
*
* @param attributes - TwiML attributes
* @param name - Queue name
*/
queue(name: string): VoiceResponse.Queue;
queue(attributes: VoiceResponse.QueueAttributes, name: string): VoiceResponse.Queue;
/**
* <Record> TwiML Verb
*
* @param attributes - TwiML attributes
*/
record(attributes?: VoiceResponse.RecordAttributes): VoiceResponse.Record;
/**
* <Redirect> TwiML Verb
*
* @param attributes - TwiML attributes
* @param url - Redirect URL
*/
redirect(url: string): VoiceResponse.Redirect;
redirect(attributes: VoiceResponse.RedirectAttributes, url: string): VoiceResponse.Redirect;
/**
* <Refer> TwiML Verb
*
* @param attributes - TwiML attributes
*/
refer(attributes?: VoiceResponse.ReferAttributes): VoiceResponse.Refer;
/**
* <Reject> TwiML Verb
*
* @param attributes - TwiML attributes
*/
reject(attributes?: VoiceResponse.RejectAttributes): VoiceResponse.Reject;
/**
* <Say> TwiML Verb
*
* @param attributes - TwiML attributes
* @param message - Message to say
*/
say(message: string): VoiceResponse.Say;
say(attributes: VoiceResponse.SayAttributes, message: string): VoiceResponse.Say;
/**
* <Sms> TwiML Noun
*
* @param attributes - TwiML attributes
* @param message - Message body
*/
sms(message: string): VoiceResponse.Sms;
sms(attributes: VoiceResponse.SmsAttributes, message: string): VoiceResponse.Sms;
/**
* <Start> TwiML Verb
*
* @param attributes - TwiML attributes
*/
start(attributes?: VoiceResponse.StartAttributes): VoiceResponse.Start;
/**
* <Stop> TwiML Verb
*
* @param attributes - TwiML attributes
*/
stop(attributes?: object): VoiceResponse.Stop;
}
declare namespace VoiceResponse {
type ApplicationEvent = "initiated" | "ringing" | "answered" | "completed";
type ClientEvent = "initiated" | "ringing" | "answered" | "completed";
type ConferenceBeep = "true" | "false" | "onEnter" | "onExit";
type ConferenceEvent = "start" | "end" | "join" | "leave" | "mute" | "hold" | "modify" | "speaker" | "announcement";
type ConferenceJitterBufferSize = "large" | "medium" | "small" | "off";
type ConferenceRecord = "do-not-record" | "record-from-start";
type ConferenceRecordingEvent = "in-progress" | "completed" | "absent";
type ConferenceRegion = "us1" | "ie1" | "sg1" | "br1" | "au1" | "jp1" | "de1";
type ConferenceTrim = "trim-silence" | "do-not-trim";
type ConversationEvent = "call-initiated" | "call-ringing" | "call-answered" | "call-completed";
type ConversationRecord = "do-not-record" | "record-from-answer" | "record-from-ringing" | "record-from-answer-dual" | "record-from-ringing-dual" | "true" | "false";
type ConversationRecordingEvent = "in-progress" | "completed" | "absent";
type ConversationTrim = "trim-silence" | "do-not-trim";
type DialRecord = "do-not-record" | "record-from-answer" | "record-from-ringing" | "record-from-answer-dual" | "record-from-ringing-dual";
type DialRecordingEvent = "in-progress" | "completed" | "absent";
type DialRecordingTrack = "both" | "inbound" | "outbound";
type DialRingTone = "at" | "au" | "bg" | "br" | "be" | "ch" | "cl" | "cn" | "cz" | "de" | "dk" | "ee" | "es" | "fi" | "fr" | "gr" | "hu" | "il" | "in" | "it" | "lt" | "jp" | "mx" | "my" | "nl" | "no" | "nz" | "ph" | "pl" | "pt" | "ru" | "se" | "sg" | "th" | "uk" | "us" | "us-old" | "tw" | "ve" | "za";
type DialTrim = "trim-silence" | "do-not-trim";
type GatherInput = "dtmf" | "speech";
type GatherLanguage = "af-ZA" | "am-ET" | "ar-AE" | "ar-BH" | "ar-DZ" | "ar-EG" | "ar-IL" | "ar-IQ" | "ar-JO" | "ar-KW" | "ar-LB" | "ar-MA" | "ar-OM" | "ar-PS" | "ar-QA" | "ar-SA" | "ar-TN" | "az-AZ" | "bg-BG" | "bn-BD" | "bn-IN" | "ca-ES" | "cs-CZ" | "da-DK" | "de-DE" | "el-GR" | "en-AU" | "en-CA" | "en-GB" | "en-GH" | "en-IE" | "en-IN" | "en-KE" | "en-NG" | "en-NZ" | "en-PH" | "en-SG" | "en-TZ" | "en-US" | "en-ZA" | "es-AR" | "es-BO" | "es-CL" | "es-CO" | "es-CR" | "es-DO" | "es-EC" | "es-ES" | "es-GT" | "es-HN" | "es-MX" | "es-NI" | "es-PA" | "es-PE" | "es-PR" | "es-PY" | "es-SV" | "es-US" | "es-UY" | "es-VE" | "et-EE" | "eu-ES" | "fa-IR" | "fi-FI" | "fil-PH" | "fr-CA" | "fr-FR" | "gl-ES" | "gu-IN" | "he-IL" | "hi-IN" | "hr-HR" | "hu-HU" | "hy-AM" | "id-ID" | "is-IS" | "it-IT" | "ja-JP" | "jv-ID" | "ka-GE" | "km-KH" | "kn-IN" | "ko-KR" | "lo-LA" | "lt-LT" | "lv-LV" | "mk-MK" | "ml-IN" | "mn-MN" | "mr-IN" | "ms-MY" | "my-MM" | "nar-IQ" | "nb-NO" | "ne-NP" | "nl-BE" | "nl-NL" | "pa-guru-IN" | "pl-PL" | "pt-BR" | "pt-PT" | "ro-RO" | "ru-RU" | "si-LK" | "sk-SK" | "sl-SI" | "sq-AL" | "sr-RS" | "su-ID" | "sv-SE" | "sw-KE" | "sw-TZ" | "ta-IN" | "ta-LK" | "ta-MY" | "ta-SG" | "te-IN" | "th-TH" | "tr-TR" | "uk-UA" | "ur-IN" | "ur-PK" | "uz-UZ" | "vi-VN" | "yue-Hant-HK" | "zh" | "cmn-Hans-CN" | "zh-TW" | "cmn-Hant-TW" | "zu-ZA";
type GatherSpeechModel = "default" | "numbers_and_commands" | "phone_call" | "experimental_conversations" | "experimental_utterances";
type NumberEvent = "initiated" | "ringing" | "answered" | "completed";
type PayBankAccountType = "consumer-checking" | "consumer-savings" | "commercial-checking" | "commercial-savings";
type PayInput = "dtmf";
type PayLanguage = "de-DE" | "en-AU" | "en-CA" | "en-GB" | "en-IN" | "en-IE" | "en-NZ" | "en-PH" | "en-ZA" | "en-US" | "es-ES" | "es-US" | "fr-CA" | "fr-FR" | "it-IT";
type PayPaymentMethod = "ach-debit" | "credit-card";
type PayStatusCallbackMethod = "GET" | "POST";
type PayTokenType = "one-time" | "reusable";
type PayValidCardTypes = "visa" | "mastercard" | "amex" | "maestro" | "discover" | "optima" | "jcb" | "diners-club" | "enroute";
type PromptCardType = "visa" | "mastercard" | "amex" | "maestro" | "discover" | "optima" | "jcb" | "diners-club" | "enroute";
type PromptErrorType = "timeout" | "invalid-card-number" | "invalid-card-type" | "invalid-date" | "invalid-security-code" | "internal-error" | "input-matching-failed";
type PromptFor = "payment-card-number" | "expiration-date" | "security-code" | "postal-code" | "payment-processing" | "bank-account-number" | "bank-routing-number";
type RecordRecordingEvent = "in-progress" | "completed" | "absent";
type RecordTrim = "trim-silence" | "do-not-trim";
type RejectReason = "rejected" | "busy";
type SayLanguage = "arb" | "ca-ES" | "cy-GB" | "da-DK" | "de-DE" | "de-AT" | "en-AU" | "en-CA" | "en-GB" | "en-GB-WLS" | "en-IN" | "en-NZ" | "en-ZA" | "en-US" | "es-ES" | "es-MX" | "es-US" | "fi-FI" | "fr-CA" | "fr-FR" | "hi-IN" | "is-IS" | "it-IT" | "ja-JP" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ro-RO" | "ru-RU" | "sv-SE" | "tr-TR" | "zh-CN" | "zh-HK" | "zh-TW";
type SayVoice = "man" | "woman" | "alice" | "Polly.Aditi" | "Polly.Amy" | "Polly.Astrid" | "Polly.Bianca" | "Polly.Brian" | "Polly.Camila" | "Polly.Carla" | "Polly.Carmen" | "Polly.Celine" | "Polly.Chantal" | "Polly.Conchita" | "Polly.Cristiano" | "Polly.Dora" | "Polly.Emma" | "Polly.Enrique" | "Polly.Ewa" | "Polly.Filiz" | "Polly.Geraint" | "Polly.Giorgio" | "Polly.Gwyneth" | "Polly.Hans" | "Polly.Ines" | "Polly.Ivy" | "Polly.Jacek" | "Polly.Jan" | "Polly.Joanna" | "Polly.Joey" | "Polly.Justin" | "Polly.Karl" | "Polly.Kendra" | "Polly.Kimberly" | "Polly.Lea" | "Polly.Liv" | "Polly.Lotte" | "Polly.Lucia" | "Polly.Lupe" | "Polly.Mads" | "Polly.Maja" | "Polly.Marlene" | "Polly.Mathieu" | "Polly.Matthew" | "Polly.Maxim" | "Polly.Mia" | "Polly.Miguel" | "Polly.Mizuki" | "Polly.Naja" | "Polly.Nicole" | "Polly.Penelope" | "Polly.Raveena" | "Polly.Ricardo" | "Polly.Ruben" | "Polly.Russell" | "Polly.Salli" | "Polly.Seoyeon" | "Polly.Takumi" | "Polly.Tatyana" | "Polly.Vicki" | "Polly.Vitoria" | "Polly.Zeina" | "Polly.Zhiyu" | "Polly.Amy-Neural" | "Polly.Aria-Neural" | "Polly.Arlet-Neural" | "Polly.Arthur-Neural" | "Polly.Ayanda-Neural" | "Polly.Bianca-Neural" | "Polly.Brian-Neural" | "Polly.Camila-Neural" | "Polly.Daniel-Neural" | "Polly.Elin-Neural" | "Polly.Emma-Neural" | "Polly.Gabrielle-Neural" | "Polly.Hala-Neural" | "Polly.Hannah-Neural" | "Polly.Hiujin-Neural" | "Polly.Ida-Neural" | "Polly.Ines-Neural" | "Polly.Ivy-Neural" | "Polly.Joanna-Neural" | "Polly.Joey-Neural" | "Polly.Justin-Neural" | "Polly.Kajal-Neural" | "Polly.Kendra-Neural" | "Polly.Kevin-Neural" | "Polly.Kimberly-Neural" | "Polly.Laura-Neural" | "Polly.Lea-Neural" | "Polly.Liam-Neural" | "Polly.Lucia-Neural" | "Polly.Lupe-Neural" | "Polly.Matthew-Neural" | "Polly.Mia-Neural" | "Polly.Ola-Neural" | "Polly.Olivia-Neural" | "Polly.Pedro-Neural" | "Polly.Salli-Neural" | "Polly.Seoyeon-Neural" | "Polly.Suvi-Neural" | "Polly.Takumi-Neural" | "Polly.Vicki-Neural" | "Polly.Vitoria-Neural" | "Polly.Zhiyu-Neural";
type SipEvent = "initiated" | "ringing" | "answered" | "completed";
type SiprecTrack = "inbound_track" | "outbound_track" | "both_tracks";
type SsmlBreakStrength = "none" | "x-weak" | "weak" | "medium" | "strong" | "x-strong";
type SsmlEmphasisLevel = "strong" | "moderate" | "reduced";
type SsmlLangXmlLang = "arb" | "ar-AE" | "ca-ES" | "cmn-CN" | "cy-GB" | "da-DK" | "de-DE" | "de-AT" | "en-AU" | "en-GB" | "en-GB-WLS" | "en-IN" | "en-NZ" | "en-US" | "en-ZA" | "es-ES" | "es-MX" | "es-US" | "fi-FI" | "fr-CA" | "fr-FR" | "hi-IN" | "is-IS" | "it-IT" | "ja-JP" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "ro-RO" | "ru-RU" | "sv-SE" | "tr-TR" | "yue-CN";
type SsmlPhonemeAlphabet = "ipa" | "x-sampa" | "x-amazon-jyutping" | "x-amazon-pinyin" | "x-amazon-pron-kana" | "x-amazon-yomigana";
type SsmlSayAsFormat = "mdy" | "dmy" | "ymd" | "md" | "dm" | "ym" | "my" | "d" | "m" | "y" | "yyyymmdd";
type SsmlSayAsInterpretAs = "characters" | "spell-out" | "cardinal" | "number" | "ordinal" | "digits" | "fraction" | "unit" | "date" | "time" | "address" | "expletive" | "telephone";
type StreamStatusCallbackMethod = "GET" | "POST";
type StreamTrack = "inbound_track" | "outbound_track" | "both_tracks";
/**
* Attributes to pass to connect
*/
export interface ConnectAttributes {
/** action - Action URL */
action?: string;
/** method - Action URL method */
method?: string;
}
/**
* Attributes to pass to dial
*/
export interface DialAttributes {
/** action - Action URL */
action?: string;
/** answerOnBridge - Preserve the ringing behavior of the inbound call until the Dialed call picks up */
answerOnBridge?: boolean;
/** callerId - Caller ID to display */
callerId?: string;
/** hangupOnStar - Hangup call on star press */
hangupOnStar?: boolean;
/** method - Action URL method */
method?: string;
/** record - Record the call */
record?: DialRecord;
/** recordingStatusCallback - Recording status callback URL */
recordingStatusCallback?: string;
/** recordingStatusCallbackEvent - Recording status callback events */
recordingStatusCallbackEvent?: DialRecordingEvent[];
/** recordingStatusCallbackMethod - Recording status callback URL method */
recordingStatusCallbackMethod?: string;
/** recordingTrack - To indicate which audio track should be recorded */
recordingTrack?: DialRecordingTrack;
/** referMethod - The HTTP method to use for the refer Webhook */
referMethod?: string;
/** referUrl - Webhook that will receive future SIP REFER requests */
referUrl?: string;
/** ringTone - Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial */
ringTone?: DialRingTone;
/** sequential - Used to determine if child TwiML nouns should be dialed in order, one after the other (sequential) or dial all at once (parallel). Default is false, parallel */
sequential?: boolean;
/** timeLimit - Max time length */
timeLimit?: number;
/** timeout - Time to wait for answer */
timeout?: number;
/** trim - Trim the recording */
trim?: DialTrim;
}
/**
* Attributes to pass to enqueue
*/
export interface EnqueueAttributes {
/** action - Action URL */
action?: string;
/** maxQueueSize - Maximum size of queue */
maxQueueSize?: number;
/** method - Action URL method */
method?: string;
/** waitUrl - Wait URL */
waitUrl?: string;
/** waitUrlMethod - Wait URL method */
waitUrlMethod?: string;
/** workflowSid - TaskRouter Workflow SID */
workflowSid?: string;
}
/**
* Attributes to pass to gather
*/
export interface GatherAttributes {
/** action - Action URL */
action?: string;
/** actionOnEmptyResult - Force webhook to the action URL event if there is no input */
actionOnEmptyResult?: boolean;
/** bargeIn - Stop playing media upon speech */
bargeIn?: boolean;
/** debug - Allow debug for gather */
debug?: boolean;
/** enhanced - Use enhanced speech model */
enhanced?: boolean;
/** finishOnKey - Finish gather on key */
finishOnKey?: string;
/** hints - Speech recognition hints */
hints?: string;
/** input - Input type Twilio should accept */
input?: GatherInput[];
/** language - Language to use */
language?: GatherLanguage;
/** maxSpeechTime - Max allowed time for speech input */
maxSpeechTime?: number;
/** method - Action URL method */
method?: string;
/** numDigits - Number of digits to collect */
numDigits?: number;
/** partialResultCallback - Partial result callback URL */
partialResultCallback?: string;
/** partialResultCallbackMethod - Partial result callback URL method */
partialResultCallbackMethod?: string;
/** profanityFilter - Profanity Filter on speech */
profanityFilter?: boolean;
/** speechModel - Specify the model that is best suited for your use case */
speechModel?: GatherSpeechModel;
/** speechTimeout - Time to wait to gather speech input and it should be either auto or a positive integer. */
speechTimeout?: string;
/** timeout - Time to wait to gather input */
timeout?: number;
}
/**
* Attributes to pass to pause
*/
export interface PauseAttributes {
/** length - Length in seconds to pause */
length?: number;
}
/**
* Attributes to pass to play
*/
export interface PlayAttributes {
/** digits - Play DTMF tones for digits */
digits?: string;
/** loop - Times to loop media */
loop?: number;
}
/**
* Attributes to pass to queue
*/
export interface QueueAttributes {
/** method - Action URL method */
method?: string;
/** postWorkActivitySid - TaskRouter Activity SID */
postWorkActivitySid?: string;
/** reservationSid - TaskRouter Reservation SID */
reservationSid?: string;
/** url - Action URL */
url?: string;
}
/**
* Attributes to pass to record
*/
export interface RecordAttributes {
/** action - Action URL */
action?: string;
/** finishOnKey - Finish recording on key */
finishOnKey?: string;
/** maxLength - Max time to record in seconds */
maxLength?: number;
/** method - Action URL method */
method?: string;
/** playBeep - Play beep */
playBeep?: boolean;
/** recordingStatusCallback - Status callback URL */
recordingStatusCallback?: string;
/** recordingStatusCallbackEvent - Recording status callback events */
recordingStatusCallbackEvent?: RecordRecordingEvent[];
/** recordingStatusCallbackMethod - Status callback URL method */
recordingStatusCallbackMethod?: string;
/** timeout - Timeout to begin recording */
timeout?: number;
/** transcribe - Transcribe the recording */
transcribe?: boolean;
/** transcribeCallback - Transcribe callback URL */
transcribeCallback?: string;
/** trim - Trim the recording */
trim?: RecordTrim;
}
/**
* Attributes to pass to redirect
*/
export interface RedirectAttributes {
/** method - Redirect URL method */
method?: string;
}
/**
* Attributes to pass to reject
*/
export interface RejectAttributes {
/** reason - Rejection reason */
reason?: RejectReason;
}
/**
* Attributes to pass to say
*/
export interface SayAttributes {
/** language - Message language */
language?: SayLanguage;
/** loop - Times to loop message */
loop?: number;
/** voice - Voice to use */
voice?: SayVoice;
}
/**
* Attributes to pass to sms
*/
export interface SmsAttributes {
/** action - Action URL */
action?: string;
/** from - Number to send message from */
from?: string;
/** method - Action URL method */
method?: string;
/** statusCallback - Status callback URL */
statusCallback?: string;
/** to - Number to send message to */
to?: string;
}
/**
* Attributes to pass to pay
*/
export interface PayAttributes {
/** action - Action URL */
action?: string;
/** bankAccountType - Bank account type for ach transactions. If set, payment method attribute must be provided and value should be set to ach-debit. defaults to consumer-checking */
bankAccountType?: PayBankAccountType;
/** chargeAmount - Amount to process. If value is greater than 0 then make the payment else create a payment token */
chargeAmount?: string;
/** currency - Currency of the amount attribute */
currency?: string;
/** description - Details regarding the payment */
description?: string;
/** input - Input type Twilio should accept */
input?: PayInput;
/** language - Language to use */
language?: PayLanguage;
/** maxAttempts - Maximum number of allowed retries when gathering input */
maxAttempts?: number;
/** minPostalCodeLength - Prompt for minimum postal code length */
minPostalCodeLength?: number;
/** paymentConnector - Unique name for payment connector */
paymentConnector?: string;
/** paymentMethod - Payment method to be used. defaults to credit-card */
paymentMethod?: PayPaymentMethod;
/** postalCode - Prompt for postal code and it should be true/false or default postal code */
postalCode?: string;
/** securityCode - Prompt for security code */
securityCode?: boolean;
/** statusCallback - Status callback URL */
statusCallback?: string;
/** statusCallbackMethod - Status callback method */
statusCallbackMethod?: PayStatusCallbackMethod;
/** timeout - Time to wait to gather input */
timeout?: number;
/** tokenType - Type of token */
tokenType?: PayTokenType;
/** validCardTypes - Comma separated accepted card types */
validCardTypes?: PayValidCardTypes[];
}
/**
* Attributes to pass to prompt
*/
export interface PromptAttributes {
/** attempt - Current attempt count */
attempt?: number[];
/** cardType - Type of the credit card */
cardType?: PromptCardType[];
/** errorType - Type of error */
errorType?: PromptErrorType[];
/** for - Name of the payment source data element */
for?: PromptFor;
/** requireMatchingInputs - Require customer to input requested information twice and verify matching. */
requireMatchingInputs?: boolean;
}
/**
* Attributes to pass to start
*/
export interface StartAttributes {
/** action - Action URL */
action?: string;
/** method - Action URL method */
method?: string;
}
/**
* Attributes to pass to refer
*/
export interface ReferAttributes {
/** action - Action URL */
action?: string;
/** method - Action URL method */
method?: string;
}
/**
* Attributes to pass to stream
*/
export interface StreamAttributes {
/** connectorName - Unique name for Stream Connector */
connectorName?: string;
/** name - Friendly name given to the Stream */
name?: string;
/** statusCallback - Status Callback URL */
statusCallback?: string;
/** statusCallbackMethod - Status Callback URL method */
statusCallbackMethod?: StreamStatusCallbackMethod;
/** track - Track to be streamed to remote service */
track?: StreamTrack;
/** url - URL of the remote service where the Stream is routed */
url?: string;
}
/**
* Attributes to pass to siprec
*/
export interface SiprecAttributes {
/** connectorName - Unique name for Connector */
connectorName?: string;
/** name - Friendly name given to SIPREC */
name?: string;
/** track - Track to be streamed to remote service */
track?: SiprecTrack;
}
/**
* Attributes to pass to parameter
*/
export interface ParameterAttributes {
/** name - The name of the custom parameter */
name?: string;
/** value - The value of the custom parameter */
value?: string;
}
/**
* Attributes to pass to parameter
*/
export interface ParameterAttributes {
/** name - The name of the custom parameter */
name?: string;
/** value - The value of the custom parameter */
value?: string;
}
/**
* Attributes to pass to stream
*/
export interface StreamAttributes {
/** connectorName - Unique name for Stream Connector */
connectorName?: string;
/** name - Friendly name given to the Stream */
name?: string;
/** statusCallback - Status Callback URL */
statusCallback?: string;
/** statusCallbackMethod - Status Callback URL method */
statusCallbackMethod?: StreamStatusCallbackMethod;
/** track - Track to be streamed to remote service */
track?: StreamTrack;
/** url - URL of the remote service where the Stream is routed */
url?: string;
}
/**
* Attributes to pass to siprec
*/
export interface SiprecAttributes {
/** connectorName - Unique name for Connector */
connectorName?: string;
/** name - Friendly name given to SIPREC */
name?: string;
/** track - Track to be streamed to remote service */
track?: SiprecTrack;
}
/**
* Attributes to pass to say
*/
export interface SayAttributes {
/** language - Message language */
language?: SayLanguage;
/** loop - Times to loop message */
loop?: number;
/** voice - Voice to use */
voice?: SayVoice;
}
/**
* Attributes to pass to play
*/
export interface PlayAttributes {
/** digits - Play DTMF tones for digits */
digits?: string;
/** loop - Times to loop media */
loop?: number;
}
/**
* Attributes to pass to pause
*/
export interface PauseAttributes {
/** length - Length in seconds to pause */
length?: number;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to break
*/
export interface SsmlBreakAttributes {
/** strength - Set a pause based on strength */
strength?: SsmlBreakStrength;
/** time - Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms */
time?: string;
}
/**
* Attributes to pass to emphasis
*/
export interface SsmlEmphasisAttributes {
/** level - Specify the degree of emphasis */
level?: SsmlEmphasisLevel;
}
/**
* Attributes to pass to lang
*/
export interface SsmlLangAttributes {
/** xml:lang - Specify the language */
"xml:lang"?: SsmlLangXmlLang;
}
/**
* Attributes to pass to phoneme
*/
export interface SsmlPhonemeAttributes {
/** alphabet - Specify the phonetic alphabet */
alphabet?: SsmlPhonemeAlphabet;
/** ph - Specifiy the phonetic symbols for pronunciation */
ph?: string;
}
/**
* Attributes to pass to prosody
*/
export interface SsmlProsodyAttributes {
/** pitch - Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% */
pitch?: string;
/** rate - Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% */
rate?: string;
/** volume - Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB */
volume?: string;
}
/**
* Attributes to pass to sayAs
*/
export interface SsmlSayAsAttributes {
/** format - Specify the format of the date when interpret-as is set to date */
format?: SsmlSayAsFormat;
/** interpret-as - Specify the type of words are spoken */
"interpret-as"?: SsmlSayAsInterpretAs;
}
/**
* Attributes to pass to sub
*/
export interface SsmlSubAttributes {
/** alias - Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation */
alias?: string;
}
/**
* Attributes to pass to w
*/
export interface SsmlWAttributes {
/** role - Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning */
role?: string;
}
/**
* Attributes to pass to prompt
*/
export interface PromptAttributes {
/** attempt - Current attempt count */
attempt?: number[];
/** cardType - Type of the credit card */
cardType?: PromptCardType[];
/** errorType - Type of error */
errorType?: PromptErrorType[];
/** for - Name of the payment source data element */
for?: PromptFor;
/** requireMatchingInputs - Require customer to input requested information twice and verify matching. */
requireMatchingInputs?: boolean;
}
/**
* Attributes to pass to parameter
*/
export interface ParameterAttributes {
/** name - The name of the custom parameter */
name?: string;
/** value - The value of the custom parameter */
value?: string;
}
/**
* Attributes to pass to parameter
*/
export interface ParameterAttributes {
/** name - The name of the custom parameter */
name?: string;
/** value - The value of the custom parameter */
value?: string;
}
/**
* Attributes to pass to parameter
*/
export interface ParameterAttributes {
/** name - The name of the custom parameter */
name?: string;
/** value - The value of the custom parameter */
value?: string;
}
/**
* Attributes to pass to say
*/
export interface SayAttributes {
/** language - Message language */
language?: SayLanguage;
/** loop - Times to loop message */
loop?: number;
/** voice - Voice to use */
voice?: SayVoice;
}
/**
* Attributes to pass to pause
*/
export interface PauseAttributes {
/** length - Length in seconds to pause */
length?: number;
}
/**
* Attributes to pass to play
*/
export interface PlayAttributes {
/** digits - Play DTMF tones for digits */
digits?: string;
/** loop - Times to loop media */
loop?: number;
}
/**
* Attributes to pass to task
*/
export interface TaskAttributes {
/** priority - Task priority */
priority?: number;
/** timeout - Timeout associated with task */
timeout?: number;
}
/**
* Attributes to pass to client
*/
export interface ClientAttributes {
/** method - Client URL Method */
method?: string;
/** statusCallback - Status Callback URL */
statusCallback?: string;
/** statusCallbackEvent - Events to trigger status callback */
statusCallbackEvent?: ClientEvent[];
/** statusCallbackMethod - Status Callback URL Method */
statusCallbackMethod?: string;
/** url - Client URL */
url?: string;
}
/**
* Attributes to pass to conference
*/
export interface ConferenceAttributes {
/** beep - Play beep when joining */
beep?: ConferenceBeep;
/** coach - Call coach */
coach?: string;
/** endConferenceOnExit - End the conferenceon exit */
endConferenceOnExit?: boolean;
/** eventCallbackUrl - Event callback URL */
eventCallbackUrl?: string;
/** jitterBufferSize - Size of jitter buffer for participant */
jitterBufferSize?: ConferenceJitterBufferSize;
/** maxParticipants - Maximum number of participants */
maxParticipants?: number;
/** muted - Join the conference muted */
muted?: boolean;
/** participantLabel - A label for participant */
participantLabel?: string;
/** record - Record the conference */
record?: ConferenceRecord;
/** recordingStatusCallback - Recording status callback URL */
recordingStatusCallback?: string;
/** recordingStatusCallbackEvent - Recording status callback events */
recordingStatusCallbackEvent?: ConferenceRecordingEvent[];
/** recordingStatusCallbackMethod - Recording status callback URL method */
recordingStatusCallbackMethod?: string;
/** region - Conference region */
region?: ConferenceRegion;
/** startConferenceOnEnter - Start the conference on enter */
startConferenceOnEnter?: boolean;
/** statusCallback - Status callback URL */
statusCallback?: string;
/** statusCallbackEvent - Events to call status callback URL */
statusCallbackEvent?: ConferenceEvent[];
/** statusCallbackMethod - Status callback URL method */
statusCallbackMethod?: string;
/** trim - Trim the conference recording */
trim?: ConferenceTrim;
/** waitMethod - Wait URL method */
waitMethod?: string;
/** waitUrl - Wait URL */
waitUrl?: string;
}
/**
* Attributes to pass to number
*/
export interface NumberAttributes {
/** amdStatusCallback - The URL we should call to send amd status information to your application */
amdStatusCallback?: string;
/** amdStatusCallbackMethod - HTTP Method to use with amd_status_callback */
amdStatusCallbackMethod?: string;
/** byoc - BYOC trunk SID (Beta) */
byoc?: string;
/** machineDetection - Enable machine detection or end of greeting detection */
machineDetection?: string;
/** machineDetectionSilenceTimeout - Number of milliseconds of initial silence */
machineDetectionSilenceTimeout?: number;
/** machineDetectionSpeechEndThreshold - Number of milliseconds of silence after speech activity */
machineDetectionSpeechEndThreshold?: number;
/** machineDetectionSpeechThreshold - Number of milliseconds for measuring stick for the length of the speech activity */
machineDetectionSpeechThreshold?: number;
/** machineDetectionTimeout - Number of seconds to wait for machine detection */
machineDetectionTimeout?: number;
/** method - TwiML URL method */
method?: string;
/** sendDigits - DTMF tones to play when the call is answered */
sendDigits?: string;
/** statusCallback - Status callback URL */
statusCallback?: string;
/** statusCallbackEvent - Events to call status callback */
statusCallbackEvent?: NumberEvent[];
/** statusCallbackMethod - Status callback URL method */
statusCallbackMethod?: string;
/** url - TwiML URL */
url?: string;
}
/**
* Attributes to pass to queue
*/
export interface QueueAttributes {
/** method - Action URL method */
method?: string;
/** postWorkActivitySid - TaskRouter Activity SID */
postWorkActivitySid?: string;
/** reservationSid - TaskRouter Reservation SID */
reservationSid?: string;
/** url - Action URL */
url?: string;
}
/**
* Attributes to pass to sip
*/
export interface SipAttributes {
/** amdStatusCallback - The URL we should call to send amd status information to your application */
amdStatusCallback?: string;
/** amdStatusCallbackMethod - HTTP Method to use