Source code for twilio.twiml.voice_response

# coding=utf-8
r"""
This code was generated by
\ / _    _  _|   _  _
 | (_)\/(_)(_|\/| |(/_  v1.0.0
      /       /
"""

import json
from twilio.base.obsolete import deprecated_method
from twilio.twiml import (
    TwiML,
    format_language,
)


[docs]class VoiceResponse(TwiML): """ <Response> TwiML for Voice """ def __init__(self, **kwargs): super(VoiceResponse, self).__init__(**kwargs) self.name = 'Response'
[docs] def connect(self, action=None, method=None, **kwargs): """ Create a <Connect> element :param action: Action URL :param method: Action URL method :param kwargs: additional attributes :returns: <Connect> element """ return self.nest(Connect(action=action, method=method, **kwargs))
[docs] def dial(self, number=None, action=None, method=None, timeout=None, hangup_on_star=None, time_limit=None, caller_id=None, record=None, trim=None, recording_status_callback=None, recording_status_callback_method=None, recording_status_callback_event=None, answer_on_bridge=None, ring_tone=None, recording_track=None, sequential=None, refer_url=None, refer_method=None, **kwargs): """ Create a <Dial> element :param number: Phone number to dial :param action: Action URL :param method: Action URL method :param timeout: Time to wait for answer :param hangup_on_star: Hangup call on star press :param time_limit: Max time length :param caller_id: Caller ID to display :param record: Record the call :param trim: Trim the recording :param recording_status_callback: Recording status callback URL :param recording_status_callback_method: Recording status callback URL method :param recording_status_callback_event: Recording status callback events :param answer_on_bridge: Preserve the ringing behavior of the inbound call until the Dialed call picks up :param ring_tone: Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial :param recording_track: To indicate which audio track should be recorded :param 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 :param refer_url: Webhook that will receive future SIP REFER requests :param refer_method: The HTTP method to use for the refer Webhook :param kwargs: additional attributes :returns: <Dial> element """ return self.nest(Dial( number=number, action=action, method=method, timeout=timeout, hangup_on_star=hangup_on_star, time_limit=time_limit, caller_id=caller_id, record=record, trim=trim, recording_status_callback=recording_status_callback, recording_status_callback_method=recording_status_callback_method, recording_status_callback_event=recording_status_callback_event, answer_on_bridge=answer_on_bridge, ring_tone=ring_tone, recording_track=recording_track, sequential=sequential, refer_url=refer_url, refer_method=refer_method, **kwargs ))
[docs] def echo(self, **kwargs): """ Create a <Echo> element :param kwargs: additional attributes :returns: <Echo> element """ return self.nest(Echo(**kwargs))
[docs] def enqueue(self, name=None, action=None, method=None, wait_url=None, wait_url_method=None, workflow_sid=None, **kwargs): """ Create a <Enqueue> element :param name: Friendly name :param action: Action URL :param method: Action URL method :param wait_url: Wait URL :param wait_url_method: Wait URL method :param workflow_sid: TaskRouter Workflow SID :param kwargs: additional attributes :returns: <Enqueue> element """ return self.nest(Enqueue( name=name, action=action, method=method, wait_url=wait_url, wait_url_method=wait_url_method, workflow_sid=workflow_sid, **kwargs ))
[docs] def gather(self, input=None, action=None, method=None, timeout=None, speech_timeout=None, max_speech_time=None, profanity_filter=None, finish_on_key=None, num_digits=None, partial_result_callback=None, partial_result_callback_method=None, language=None, hints=None, barge_in=None, debug=None, action_on_empty_result=None, speech_model=None, enhanced=None, **kwargs): """ Create a <Gather> element :param input: Input type Twilio should accept :param action: Action URL :param method: Action URL method :param timeout: Time to wait to gather input :param speech_timeout: Time to wait to gather speech input and it should be either auto or a positive integer. :param max_speech_time: Max allowed time for speech input :param profanity_filter: Profanity Filter on speech :param finish_on_key: Finish gather on key :param num_digits: Number of digits to collect :param partial_result_callback: Partial result callback URL :param partial_result_callback_method: Partial result callback URL method :param language: Language to use :param hints: Speech recognition hints :param barge_in: Stop playing media upon speech :param debug: Allow debug for gather :param action_on_empty_result: Force webhook to the action URL event if there is no input :param speech_model: Specify the model that is best suited for your use case :param enhanced: Use enhanced speech model :param kwargs: additional attributes :returns: <Gather> element """ return self.nest(Gather( input=input, action=action, method=method, timeout=timeout, speech_timeout=speech_timeout, max_speech_time=max_speech_time, profanity_filter=profanity_filter, finish_on_key=finish_on_key, num_digits=num_digits, partial_result_callback=partial_result_callback, partial_result_callback_method=partial_result_callback_method, language=language, hints=hints, barge_in=barge_in, debug=debug, action_on_empty_result=action_on_empty_result, speech_model=speech_model, enhanced=enhanced, **kwargs ))
[docs] def hangup(self, **kwargs): """ Create a <Hangup> element :param kwargs: additional attributes :returns: <Hangup> element """ return self.nest(Hangup(**kwargs))
[docs] def leave(self, **kwargs): """ Create a <Leave> element :param kwargs: additional attributes :returns: <Leave> element """ return self.nest(Leave(**kwargs))
[docs] def pause(self, length=None, **kwargs): """ Create a <Pause> element :param length: Length in seconds to pause :param kwargs: additional attributes :returns: <Pause> element """ return self.nest(Pause(length=length, **kwargs))
[docs] def play(self, url=None, loop=None, digits=None, **kwargs): """ Create a <Play> element :param url: Media URL :param loop: Times to loop media :param digits: Play DTMF tones for digits :param kwargs: additional attributes :returns: <Play> element """ return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
[docs] def queue(self, name, url=None, method=None, reservation_sid=None, post_work_activity_sid=None, **kwargs): """ Create a <Queue> element :param name: Queue name :param url: Action URL :param method: Action URL method :param reservation_sid: TaskRouter Reservation SID :param post_work_activity_sid: TaskRouter Activity SID :param kwargs: additional attributes :returns: <Queue> element """ return self.nest(Queue( name, url=url, method=method, reservation_sid=reservation_sid, post_work_activity_sid=post_work_activity_sid, **kwargs ))
[docs] def record(self, action=None, method=None, timeout=None, finish_on_key=None, max_length=None, play_beep=None, trim=None, recording_status_callback=None, recording_status_callback_method=None, recording_status_callback_event=None, transcribe=None, transcribe_callback=None, **kwargs): """ Create a <Record> element :param action: Action URL :param method: Action URL method :param timeout: Timeout to begin recording :param finish_on_key: Finish recording on key :param max_length: Max time to record in seconds :param play_beep: Play beep :param trim: Trim the recording :param recording_status_callback: Status callback URL :param recording_status_callback_method: Status callback URL method :param recording_status_callback_event: Recording status callback events :param transcribe: Transcribe the recording :param transcribe_callback: Transcribe callback URL :param kwargs: additional attributes :returns: <Record> element """ return self.nest(Record( action=action, method=method, timeout=timeout, finish_on_key=finish_on_key, max_length=max_length, play_beep=play_beep, trim=trim, recording_status_callback=recording_status_callback, recording_status_callback_method=recording_status_callback_method, recording_status_callback_event=recording_status_callback_event, transcribe=transcribe, transcribe_callback=transcribe_callback, **kwargs ))
[docs] def redirect(self, url, method=None, **kwargs): """ Create a <Redirect> element :param url: Redirect URL :param method: Redirect URL method :param kwargs: additional attributes :returns: <Redirect> element """ return self.nest(Redirect(url, method=method, **kwargs))
[docs] def reject(self, reason=None, **kwargs): """ Create a <Reject> element :param reason: Rejection reason :param kwargs: additional attributes :returns: <Reject> element """ return self.nest(Reject(reason=reason, **kwargs))
[docs] def say(self, message=None, voice=None, loop=None, language=None, **kwargs): """ Create a <Say> element :param message: Message to say :param voice: Voice to use :param loop: Times to loop message :param language: Message language :param kwargs: additional attributes :returns: <Say> element """ return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
[docs] def sms(self, message, to=None, from_=None, action=None, method=None, status_callback=None, **kwargs): """ Create a <Sms> element :param message: Message body :param to: Number to send message to :param from: Number to send message from :param action: Action URL :param method: Action URL method :param status_callback: Status callback URL :param kwargs: additional attributes :returns: <Sms> element """ return self.nest(Sms( message, to=to, from_=from_, action=action, method=method, status_callback=status_callback, **kwargs ))
[docs] def pay(self, input=None, action=None, bank_account_type=None, status_callback=None, status_callback_method=None, timeout=None, max_attempts=None, security_code=None, postal_code=None, min_postal_code_length=None, payment_connector=None, payment_method=None, token_type=None, charge_amount=None, currency=None, description=None, valid_card_types=None, language=None, **kwargs): """ Create a <Pay> element :param input: Input type Twilio should accept :param action: Action URL :param bank_account_type: 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 :param status_callback: Status callback URL :param status_callback_method: Status callback method :param timeout: Time to wait to gather input :param max_attempts: Maximum number of allowed retries when gathering input :param security_code: Prompt for security code :param postal_code: Prompt for postal code and it should be true/false or default postal code :param min_postal_code_length: Prompt for minimum postal code length :param payment_connector: Unique name for payment connector :param payment_method: Payment method to be used. defaults to credit-card :param token_type: Type of token :param charge_amount: Amount to process. If value is greater than 0 then make the payment else create a payment token :param currency: Currency of the amount attribute :param description: Details regarding the payment :param valid_card_types: Comma separated accepted card types :param language: Language to use :param kwargs: additional attributes :returns: <Pay> element """ return self.nest(Pay( input=input, action=action, bank_account_type=bank_account_type, status_callback=status_callback, status_callback_method=status_callback_method, timeout=timeout, max_attempts=max_attempts, security_code=security_code, postal_code=postal_code, min_postal_code_length=min_postal_code_length, payment_connector=payment_connector, payment_method=payment_method, token_type=token_type, charge_amount=charge_amount, currency=currency, description=description, valid_card_types=valid_card_types, language=language, **kwargs ))
[docs] def prompt(self, for_=None, error_type=None, card_type=None, attempt=None, **kwargs): """ Create a <Prompt> element :param for_: Name of the payment source data element :param error_type: Type of error :param card_type: Type of the credit card :param attempt: Current attempt count :param kwargs: additional attributes :returns: <Prompt> element """ return self.nest(Prompt( for_=for_, error_type=error_type, card_type=card_type, attempt=attempt, **kwargs ))
[docs] def start(self, action=None, method=None, **kwargs): """ Create a <Start> element :param action: Action URL :param method: Action URL method :param kwargs: additional attributes :returns: <Start> element """ return self.nest(Start(action=action, method=method, **kwargs))
[docs] def stop(self, **kwargs): """ Create a <Stop> element :param kwargs: additional attributes :returns: <Stop> element """ return self.nest(Stop(**kwargs))
[docs] def refer(self, action=None, method=None, **kwargs): """ Create a <Refer> element :param action: Action URL :param method: Action URL method :param kwargs: additional attributes :returns: <Refer> element """ return self.nest(Refer(action=action, method=method, **kwargs))
[docs]class Refer(TwiML): """ <Refer> TwiML Verb """ def __init__(self, **kwargs): super(Refer, self).__init__(**kwargs) self.name = 'Refer'
[docs] def sip(self, sip_url, **kwargs): """ Create a <Sip> element :param sip_url: SIP URL :param kwargs: additional attributes :returns: <Sip> element """ return self.nest(ReferSip(sip_url, **kwargs))
[docs] @deprecated_method('sip') def refer_sip(self, sip_url, **kwargs): """ Create a <Sip> element :param sip_url: SIP URL :param kwargs: additional attributes :returns: <Sip> element """ return self.sip(sip_url, **kwargs)
[docs]class ReferSip(TwiML): """ <Sip> TwiML Noun used in <Refer> """ def __init__(self, sip_url, **kwargs): super(ReferSip, self).__init__(**kwargs) self.name = 'Sip' self.value = sip_url
[docs]class Stop(TwiML): """ <Stop> TwiML Verb """ def __init__(self, **kwargs): super(Stop, self).__init__(**kwargs) self.name = 'Stop'
[docs] def stream(self, name=None, connector_name=None, url=None, track=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <Stream> element :param name: Friendly name given to the Stream :param connector_name: Unique name for Stream Connector :param url: URL of the remote service where the Stream is routed :param track: Track to be streamed to remote service :param status_callback: Status Callback URL :param status_callback_method: Status Callback URL method :param kwargs: additional attributes :returns: <Stream> element """ return self.nest(Stream( name=name, connector_name=connector_name, url=url, track=track, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs] def siprec(self, name=None, connector_name=None, track=None, **kwargs): """ Create a <Siprec> element :param name: Friendly name given to SIPREC :param connector_name: Unique name for Connector :param track: Track to be streamed to remote service :param kwargs: additional attributes :returns: <Siprec> element """ return self.nest(Siprec(name=name, connector_name=connector_name, track=track, **kwargs))
[docs]class Siprec(TwiML): """ <Siprec> TwiML Noun """ def __init__(self, **kwargs): super(Siprec, self).__init__(**kwargs) self.name = 'Siprec'
[docs] def parameter(self, name=None, value=None, **kwargs): """ Create a <Parameter> element :param name: The name of the custom parameter :param value: The value of the custom parameter :param kwargs: additional attributes :returns: <Parameter> element """ return self.nest(Parameter(name=name, value=value, **kwargs))
[docs]class Parameter(TwiML): """ <Parameter> TwiML Noun """ def __init__(self, **kwargs): super(Parameter, self).__init__(**kwargs) self.name = 'Parameter'
[docs]class Stream(TwiML): """ <Stream> TwiML Noun """ def __init__(self, **kwargs): super(Stream, self).__init__(**kwargs) self.name = 'Stream'
[docs] def parameter(self, name=None, value=None, **kwargs): """ Create a <Parameter> element :param name: The name of the custom parameter :param value: The value of the custom parameter :param kwargs: additional attributes :returns: <Parameter> element """ return self.nest(Parameter(name=name, value=value, **kwargs))
[docs]class Start(TwiML): """ <Start> TwiML Verb """ def __init__(self, **kwargs): super(Start, self).__init__(**kwargs) self.name = 'Start'
[docs] def stream(self, name=None, connector_name=None, url=None, track=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <Stream> element :param name: Friendly name given to the Stream :param connector_name: Unique name for Stream Connector :param url: URL of the remote service where the Stream is routed :param track: Track to be streamed to remote service :param status_callback: Status Callback URL :param status_callback_method: Status Callback URL method :param kwargs: additional attributes :returns: <Stream> element """ return self.nest(Stream( name=name, connector_name=connector_name, url=url, track=track, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs] def siprec(self, name=None, connector_name=None, track=None, **kwargs): """ Create a <Siprec> element :param name: Friendly name given to SIPREC :param connector_name: Unique name for Connector :param track: Track to be streamed to remote service :param kwargs: additional attributes :returns: <Siprec> element """ return self.nest(Siprec(name=name, connector_name=connector_name, track=track, **kwargs))
[docs]class Prompt(TwiML): """ <Prompt> Twiml Verb """ def __init__(self, **kwargs): super(Prompt, self).__init__(**kwargs) self.name = 'Prompt'
[docs] def say(self, message=None, voice=None, loop=None, language=None, **kwargs): """ Create a <Say> element :param message: Message to say :param voice: Voice to use :param loop: Times to loop message :param language: Message language :param kwargs: additional attributes :returns: <Say> element """ return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
[docs] def play(self, url=None, loop=None, digits=None, **kwargs): """ Create a <Play> element :param url: Media URL :param loop: Times to loop media :param digits: Play DTMF tones for digits :param kwargs: additional attributes :returns: <Play> element """ return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
[docs] def pause(self, length=None, **kwargs): """ Create a <Pause> element :param length: Length in seconds to pause :param kwargs: additional attributes :returns: <Pause> element """ return self.nest(Pause(length=length, **kwargs))
[docs]class Pause(TwiML): """ <Pause> TwiML Verb """ def __init__(self, **kwargs): super(Pause, self).__init__(**kwargs) self.name = 'Pause'
[docs]class Play(TwiML): """ <Play> TwiML Verb """ def __init__(self, url=None, **kwargs): super(Play, self).__init__(**kwargs) self.name = 'Play' if url: self.value = url
[docs]class Say(TwiML): """ <Say> TwiML Verb """ def __init__(self, message=None, **kwargs): super(Say, self).__init__(**kwargs) self.name = 'Say' if message: self.value = message
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.nest(SsmlP(words=words, **kwargs))
[docs] @deprecated_method('p') def ssml_p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.p(words=words, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.nest(SsmlS(words=words, **kwargs))
[docs] @deprecated_method('s') def ssml_s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.s(words=words, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlW(TwiML): """ Improving Pronunciation by Specifying Parts of Speech in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlW, self).__init__(**kwargs) self.name = 'w' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs]class SsmlSub(TwiML): """ Pronouncing Acronyms and Abbreviations in <Say> """ def __init__(self, words, **kwargs): super(SsmlSub, self).__init__(**kwargs) self.name = 'sub' self.value = words
[docs]class SsmlSayAs(TwiML): """ Controlling How Special Types of Words Are Spoken in <Say> """ def __init__(self, words, **kwargs): super(SsmlSayAs, self).__init__(**kwargs) self.name = 'say-as' self.value = words
[docs]class SsmlProsody(TwiML): """ Controling Volume, Speaking Rate, and Pitch in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlProsody, self).__init__(**kwargs) self.name = 'prosody' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.nest(SsmlP(words=words, **kwargs))
[docs] @deprecated_method('p') def ssml_p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.p(words=words, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.nest(SsmlS(words=words, **kwargs))
[docs] @deprecated_method('s') def ssml_s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.s(words=words, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlS(TwiML): """ Adding A Pause Between Sentences in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlS, self).__init__(**kwargs) self.name = 's' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlPhoneme(TwiML): """ Using Phonetic Pronunciation in <Say> """ def __init__(self, words, **kwargs): super(SsmlPhoneme, self).__init__(**kwargs) self.name = 'phoneme' self.value = words
[docs]class SsmlLang(TwiML): """ Specifying Another Language for Specific Words in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlLang, self).__init__(**kwargs) self.name = 'lang' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.nest(SsmlP(words=words, **kwargs))
[docs] @deprecated_method('p') def ssml_p(self, words=None, **kwargs): """ Create a <P> element :param words: Words to speak :param kwargs: additional attributes :returns: <P> element """ return self.p(words=words, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.nest(SsmlS(words=words, **kwargs))
[docs] @deprecated_method('s') def ssml_s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.s(words=words, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlP(TwiML): """ Adding a Pause Between Paragraphs in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlP, self).__init__(**kwargs) self.name = 'p' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.nest(SsmlS(words=words, **kwargs))
[docs] @deprecated_method('s') def ssml_s(self, words=None, **kwargs): """ Create a <S> element :param words: Words to speak :param kwargs: additional attributes :returns: <S> element """ return self.s(words=words, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlEmphasis(TwiML): """ Emphasizing Words in <Say> """ def __init__(self, words=None, **kwargs): super(SsmlEmphasis, self).__init__(**kwargs) self.name = 'emphasis' if words: self.value = words
[docs] def break_(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.nest(SsmlBreak(strength=strength, time=time, **kwargs))
[docs] @deprecated_method('break_') def ssml_break(self, strength=None, time=None, **kwargs): """ Create a <Break> element :param strength: Set a pause based on strength :param time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms :param kwargs: additional attributes :returns: <Break> element """ return self.break_(strength=strength, time=time, **kwargs)
[docs] def emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.nest(SsmlEmphasis(words=words, level=level, **kwargs))
[docs] @deprecated_method('emphasis') def ssml_emphasis(self, words=None, level=None, **kwargs): """ Create a <Emphasis> element :param words: Words to emphasize :param level: Specify the degree of emphasis :param kwargs: additional attributes :returns: <Emphasis> element """ return self.emphasis(words=words, level=level, **kwargs)
[docs] def lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.nest(SsmlLang(words=words, xml_lang=xml_lang, **kwargs))
[docs] @deprecated_method('lang') def ssml_lang(self, words=None, xml_lang=None, **kwargs): """ Create a <Lang> element :param words: Words to speak :param xml:lang: Specify the language :param kwargs: additional attributes :returns: <Lang> element """ return self.lang(words=words, xml_lang=xml_lang, **kwargs)
[docs] def phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.nest(SsmlPhoneme(words, alphabet=alphabet, ph=ph, **kwargs))
[docs] @deprecated_method('phoneme') def ssml_phoneme(self, words, alphabet=None, ph=None, **kwargs): """ Create a <Phoneme> element :param words: Words to speak :param alphabet: Specify the phonetic alphabet :param ph: Specifiy the phonetic symbols for pronunciation :param kwargs: additional attributes :returns: <Phoneme> element """ return self.phoneme(words, alphabet=alphabet, ph=ph, **kwargs)
[docs] def prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.nest(SsmlProsody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs))
[docs] @deprecated_method('prosody') def ssml_prosody(self, words=None, volume=None, rate=None, pitch=None, **kwargs): """ Create a <Prosody> element :param words: Words to speak :param volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB :param rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n% :param pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n% :param kwargs: additional attributes :returns: <Prosody> element """ return self.prosody(words=words, volume=volume, rate=rate, pitch=pitch, **kwargs)
[docs] def say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.nest(SsmlSayAs(words, interpret_as=interpret_as, role=role, **kwargs))
[docs] @deprecated_method('say_as') def ssml_say_as(self, words, interpret_as=None, role=None, **kwargs): """ Create a <Say-As> element :param words: Words to be interpreted :param interpret-as: Specify the type of words are spoken :param role: Specify the format of the date when interpret-as is set to date :param kwargs: additional attributes :returns: <Say-As> element """ return self.say_as(words, interpret_as=interpret_as, role=role, **kwargs)
[docs] def sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.nest(SsmlSub(words, alias=alias, **kwargs))
[docs] @deprecated_method('sub') def ssml_sub(self, words, alias=None, **kwargs): """ Create a <Sub> element :param words: Words to be substituted :param alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation :param kwargs: additional attributes :returns: <Sub> element """ return self.sub(words, alias=alias, **kwargs)
[docs] def w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.nest(SsmlW(words=words, role=role, **kwargs))
[docs] @deprecated_method('w') def ssml_w(self, words=None, role=None, **kwargs): """ Create a <W> element :param words: Words to speak :param role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning :param kwargs: additional attributes :returns: <W> element """ return self.w(words=words, role=role, **kwargs)
[docs]class SsmlBreak(TwiML): """ Adding a Pause in <Say> """ def __init__(self, **kwargs): super(SsmlBreak, self).__init__(**kwargs) self.name = 'break'
[docs]class Pay(TwiML): """ <Pay> Twiml Verb """ def __init__(self, **kwargs): super(Pay, self).__init__(**kwargs) self.name = 'Pay'
[docs] def prompt(self, for_=None, error_type=None, card_type=None, attempt=None, **kwargs): """ Create a <Prompt> element :param for_: Name of the payment source data element :param error_type: Type of error :param card_type: Type of the credit card :param attempt: Current attempt count :param kwargs: additional attributes :returns: <Prompt> element """ return self.nest(Prompt( for_=for_, error_type=error_type, card_type=card_type, attempt=attempt, **kwargs ))
[docs] def parameter(self, name=None, value=None, **kwargs): """ Create a <Parameter> element :param name: The name of the custom parameter :param value: The value of the custom parameter :param kwargs: additional attributes :returns: <Parameter> element """ return self.nest(Parameter(name=name, value=value, **kwargs))
[docs]class Sms(TwiML): """ <Sms> TwiML Noun """ def __init__(self, message, **kwargs): super(Sms, self).__init__(**kwargs) self.name = 'Sms' self.value = message
[docs]class Reject(TwiML): """ <Reject> TwiML Verb """ def __init__(self, **kwargs): super(Reject, self).__init__(**kwargs) self.name = 'Reject'
[docs]class Redirect(TwiML): """ <Redirect> TwiML Verb """ def __init__(self, url, **kwargs): super(Redirect, self).__init__(**kwargs) self.name = 'Redirect' self.value = url
[docs]class Record(TwiML): """ <Record> TwiML Verb """ def __init__(self, **kwargs): super(Record, self).__init__(**kwargs) self.name = 'Record'
[docs]class Queue(TwiML): """ <Queue> TwiML Noun """ def __init__(self, name, **kwargs): super(Queue, self).__init__(**kwargs) self.name = 'Queue' self.value = name
[docs]class Leave(TwiML): """ <Leave> TwiML Verb """ def __init__(self, **kwargs): super(Leave, self).__init__(**kwargs) self.name = 'Leave'
[docs]class Hangup(TwiML): """ <Hangup> TwiML Verb """ def __init__(self, **kwargs): super(Hangup, self).__init__(**kwargs) self.name = 'Hangup'
[docs]class Gather(TwiML): """ <Gather> TwiML Verb """ def __init__(self, **kwargs): super(Gather, self).__init__(**kwargs) self.name = 'Gather'
[docs] def say(self, message=None, voice=None, loop=None, language=None, **kwargs): """ Create a <Say> element :param message: Message to say :param voice: Voice to use :param loop: Times to loop message :param language: Message language :param kwargs: additional attributes :returns: <Say> element """ return self.nest(Say(message=message, voice=voice, loop=loop, language=language, **kwargs))
[docs] def pause(self, length=None, **kwargs): """ Create a <Pause> element :param length: Length in seconds to pause :param kwargs: additional attributes :returns: <Pause> element """ return self.nest(Pause(length=length, **kwargs))
[docs] def play(self, url=None, loop=None, digits=None, **kwargs): """ Create a <Play> element :param url: Media URL :param loop: Times to loop media :param digits: Play DTMF tones for digits :param kwargs: additional attributes :returns: <Play> element """ return self.nest(Play(url=url, loop=loop, digits=digits, **kwargs))
[docs]class Enqueue(TwiML): """ <Enqueue> TwiML Noun """ def __init__(self, name=None, **kwargs): super(Enqueue, self).__init__(**kwargs) self.name = 'Enqueue' if name: self.value = name
[docs] def task(self, body, priority=None, timeout=None, **kwargs): """ Create a <Task> element :param body: TaskRouter task attributes :param priority: Task priority :param timeout: Timeout associated with task :param kwargs: additional attributes :returns: <Task> element """ return self.nest(Task(body, priority=priority, timeout=timeout, **kwargs))
[docs]class Task(TwiML): """ <Task> TwiML Noun """ def __init__(self, body, **kwargs): super(Task, self).__init__(**kwargs) self.name = 'Task' self.value = body
[docs]class Echo(TwiML): """ <Echo> TwiML Verb """ def __init__(self, **kwargs): super(Echo, self).__init__(**kwargs) self.name = 'Echo'
[docs]class Dial(TwiML): """ <Dial> TwiML Verb """ def __init__(self, number=None, **kwargs): super(Dial, self).__init__(**kwargs) self.name = 'Dial' if number: self.value = number
[docs] def client(self, identity=None, url=None, method=None, status_callback_event=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <Client> element :param identity: Client identity :param url: Client URL :param method: Client URL Method :param status_callback_event: Events to trigger status callback :param status_callback: Status Callback URL :param status_callback_method: Status Callback URL Method :param kwargs: additional attributes :returns: <Client> element """ return self.nest(Client( identity=identity, url=url, method=method, status_callback_event=status_callback_event, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs] def conference(self, name, muted=None, beep=None, start_conference_on_enter=None, end_conference_on_exit=None, wait_url=None, wait_method=None, max_participants=None, record=None, region=None, coach=None, trim=None, status_callback_event=None, status_callback=None, status_callback_method=None, recording_status_callback=None, recording_status_callback_method=None, recording_status_callback_event=None, event_callback_url=None, jitter_buffer_size=None, participant_label=None, **kwargs): """ Create a <Conference> element :param name: Conference name :param muted: Join the conference muted :param beep: Play beep when joining :param start_conference_on_enter: Start the conference on enter :param end_conference_on_exit: End the conferenceon exit :param wait_url: Wait URL :param wait_method: Wait URL method :param max_participants: Maximum number of participants :param record: Record the conference :param region: Conference region :param coach: Call coach :param trim: Trim the conference recording :param status_callback_event: Events to call status callback URL :param status_callback: Status callback URL :param status_callback_method: Status callback URL method :param recording_status_callback: Recording status callback URL :param recording_status_callback_method: Recording status callback URL method :param recording_status_callback_event: Recording status callback events :param event_callback_url: Event callback URL :param jitter_buffer_size: Size of jitter buffer for participant :param participant_label: A label for participant :param kwargs: additional attributes :returns: <Conference> element """ return self.nest(Conference( name, muted=muted, beep=beep, start_conference_on_enter=start_conference_on_enter, end_conference_on_exit=end_conference_on_exit, wait_url=wait_url, wait_method=wait_method, max_participants=max_participants, record=record, region=region, coach=coach, trim=trim, status_callback_event=status_callback_event, status_callback=status_callback, status_callback_method=status_callback_method, recording_status_callback=recording_status_callback, recording_status_callback_method=recording_status_callback_method, recording_status_callback_event=recording_status_callback_event, event_callback_url=event_callback_url, jitter_buffer_size=jitter_buffer_size, participant_label=participant_label, **kwargs ))
[docs] def number(self, phone_number, send_digits=None, url=None, method=None, status_callback_event=None, status_callback=None, status_callback_method=None, byoc=None, **kwargs): """ Create a <Number> element :param phone_number: Phone Number to dial :param send_digits: DTMF tones to play when the call is answered :param url: TwiML URL :param method: TwiML URL method :param status_callback_event: Events to call status callback :param status_callback: Status callback URL :param status_callback_method: Status callback URL method :param byoc: BYOC trunk SID (Beta) :param kwargs: additional attributes :returns: <Number> element """ return self.nest(Number( phone_number, send_digits=send_digits, url=url, method=method, status_callback_event=status_callback_event, status_callback=status_callback, status_callback_method=status_callback_method, byoc=byoc, **kwargs ))
[docs] def queue(self, name, url=None, method=None, reservation_sid=None, post_work_activity_sid=None, **kwargs): """ Create a <Queue> element :param name: Queue name :param url: Action URL :param method: Action URL method :param reservation_sid: TaskRouter Reservation SID :param post_work_activity_sid: TaskRouter Activity SID :param kwargs: additional attributes :returns: <Queue> element """ return self.nest(Queue( name, url=url, method=method, reservation_sid=reservation_sid, post_work_activity_sid=post_work_activity_sid, **kwargs ))
[docs] def sim(self, sim_sid, **kwargs): """ Create a <Sim> element :param sim_sid: SIM SID :param kwargs: additional attributes :returns: <Sim> element """ return self.nest(Sim(sim_sid, **kwargs))
[docs] def sip(self, sip_url, username=None, password=None, url=None, method=None, status_callback_event=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <Sip> element :param sip_url: SIP URL :param username: SIP Username :param password: SIP Password :param url: Action URL :param method: Action URL method :param status_callback_event: Status callback events :param status_callback: Status callback URL :param status_callback_method: Status callback URL method :param kwargs: additional attributes :returns: <Sip> element """ return self.nest(Sip( sip_url, username=username, password=password, url=url, method=method, status_callback_event=status_callback_event, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs]class Sip(TwiML): """ <Sip> TwiML Noun """ def __init__(self, sip_url, **kwargs): super(Sip, self).__init__(**kwargs) self.name = 'Sip' self.value = sip_url
[docs]class Sim(TwiML): """ <Sim> TwiML Noun """ def __init__(self, sim_sid, **kwargs): super(Sim, self).__init__(**kwargs) self.name = 'Sim' self.value = sim_sid
[docs]class Number(TwiML): """ <Number> TwiML Noun """ def __init__(self, phone_number, **kwargs): super(Number, self).__init__(**kwargs) self.name = 'Number' self.value = phone_number
[docs]class Conference(TwiML): """ <Conference> TwiML Noun """ def __init__(self, name, **kwargs): super(Conference, self).__init__(**kwargs) self.name = 'Conference' self.value = name
[docs]class Client(TwiML): """ <Client> TwiML Noun """ def __init__(self, identity=None, **kwargs): super(Client, self).__init__(**kwargs) self.name = 'Client' if identity: self.value = identity
[docs] def identity(self, client_identity, **kwargs): """ Create a <Identity> element :param client_identity: Identity of the client to dial :param kwargs: additional attributes :returns: <Identity> element """ return self.nest(Identity(client_identity, **kwargs))
[docs] def parameter(self, name=None, value=None, **kwargs): """ Create a <Parameter> element :param name: The name of the custom parameter :param value: The value of the custom parameter :param kwargs: additional attributes :returns: <Parameter> element """ return self.nest(Parameter(name=name, value=value, **kwargs))
[docs]class Identity(TwiML): """ <Identity> TwiML Noun """ def __init__(self, client_identity, **kwargs): super(Identity, self).__init__(**kwargs) self.name = 'Identity' self.value = client_identity
[docs]class Connect(TwiML): """ <Connect> TwiML Verb """ def __init__(self, **kwargs): super(Connect, self).__init__(**kwargs) self.name = 'Connect'
[docs] def room(self, name, participant_identity=None, **kwargs): """ Create a <Room> element :param name: Room name :param participant_identity: Participant identity when connecting to the Room :param kwargs: additional attributes :returns: <Room> element """ return self.nest(Room(name, participant_identity=participant_identity, **kwargs))
[docs] def autopilot(self, name, **kwargs): """ Create a <Autopilot> element :param name: Autopilot assistant sid or unique name :param kwargs: additional attributes :returns: <Autopilot> element """ return self.nest(Autopilot(name, **kwargs))
[docs] def stream(self, name=None, connector_name=None, url=None, track=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <Stream> element :param name: Friendly name given to the Stream :param connector_name: Unique name for Stream Connector :param url: URL of the remote service where the Stream is routed :param track: Track to be streamed to remote service :param status_callback: Status Callback URL :param status_callback_method: Status Callback URL method :param kwargs: additional attributes :returns: <Stream> element """ return self.nest(Stream( name=name, connector_name=connector_name, url=url, track=track, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs] def virtual_agent(self, connector_name=None, language=None, sentiment_analysis=None, status_callback=None, status_callback_method=None, **kwargs): """ Create a <VirtualAgent> element :param connector_name: Defines the conversation profile Dialogflow needs to use :param language: Language to be used by Dialogflow to transcribe speech :param sentiment_analysis: Whether sentiment analysis needs to be enabled or not :param status_callback: URL to post status callbacks from Twilio :param status_callback_method: HTTP method to use when requesting the status callback URL :param kwargs: additional attributes :returns: <VirtualAgent> element """ return self.nest(VirtualAgent( connector_name=connector_name, language=language, sentiment_analysis=sentiment_analysis, status_callback=status_callback, status_callback_method=status_callback_method, **kwargs ))
[docs] def conversation(self, service_instance_sid=None, inbound_autocreation=None, routing_assignment_timeout=None, inbound_timeout=None, record=None, trim=None, recording_status_callback=None, recording_status_callback_method=None, recording_status_callback_event=None, status_callback=None, status_callback_method=None, status_callback_event=None, **kwargs): """ Create a <Conversation> element :param service_instance_sid: Service instance Sid :param inbound_autocreation: Inbound autocreation :param routing_assignment_timeout: Routing assignment timeout :param inbound_timeout: Inbound timeout :param record: Record :param trim: Trim :param recording_status_callback: Recording status callback URL :param recording_status_callback_method: Recording status callback URL method :param recording_status_callback_event: Recording status callback events :param status_callback: Status callback URL :param status_callback_method: Status callback URL method :param status_callback_event: Events to call status callback URL :param kwargs: additional attributes :returns: <Conversation> element """ return self.nest(Conversation( service_instance_sid=service_instance_sid, inbound_autocreation=inbound_autocreation, routing_assignment_timeout=routing_assignment_timeout, inbound_timeout=inbound_timeout, record=record, trim=trim, recording_status_callback=recording_status_callback, recording_status_callback_method=recording_status_callback_method, recording_status_callback_event=recording_status_callback_event, status_callback=status_callback, status_callback_method=status_callback_method, status_callback_event=status_callback_event, **kwargs ))
[docs]class Conversation(TwiML): """ <Conversation> TwiML Noun """ def __init__(self, **kwargs): super(Conversation, self).__init__(**kwargs) self.name = 'Conversation'
[docs]class VirtualAgent(TwiML): """ <VirtualAgent> TwiML Noun """ def __init__(self, **kwargs): super(VirtualAgent, self).__init__(**kwargs) self.name = 'VirtualAgent'
[docs] def config(self, name=None, value=None, **kwargs): """ Create a <Config> element :param name: The name of the custom config :param value: The value of the custom config :param kwargs: additional attributes :returns: <Config> element """ return self.nest(Config(name=name, value=value, **kwargs))
[docs] def parameter(self, name=None, value=None, **kwargs): """ Create a <Parameter> element :param name: The name of the custom parameter :param value: The value of the custom parameter :param kwargs: additional attributes :returns: <Parameter> element """ return self.nest(Parameter(name=name, value=value, **kwargs))
[docs]class Config(TwiML): """ <Config> TwiML Noun """ def __init__(self, **kwargs): super(Config, self).__init__(**kwargs) self.name = 'Config'
[docs]class Autopilot(TwiML): """ <Autopilot> TwiML Noun """ def __init__(self, name, **kwargs): super(Autopilot, self).__init__(**kwargs) self.name = 'Autopilot' self.value = name
[docs]class Room(TwiML): """ <Room> TwiML Noun """ def __init__(self, name, **kwargs): super(Room, self).__init__(**kwargs) self.name = 'Room' self.value = name