twiml

package
v1.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 18, 2023 License: MIT Imports: 2 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddAllVerbs

func AddAllVerbs(response *etree.Element, verbs []Element)

func CreateDocument

func CreateDocument() (*etree.Document, *etree.Element)

func Messages

func Messages(verbs []Element) (string, error)

func ToXML

func ToXML(document *etree.Document) (string, error)

func Voice

func Voice(verbs []Element) (string, error)

Types

type Element

type Element interface {
	GetName() string
	GetText() string
	GetAttr() (map[string]string, map[string]string)
	GetInnerElements() []Element
}

type MessagingBody

type MessagingBody struct {
	// message: Message Body
	// OptionalAttributes: additional attributes
	Message            string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

MessagingBody <Body> TwiML Noun

func (MessagingBody) GetAttr

func (m MessagingBody) GetAttr() (map[string]string, map[string]string)

func (MessagingBody) GetInnerElements

func (m MessagingBody) GetInnerElements() []Element

func (MessagingBody) GetName

func (m MessagingBody) GetName() string

func (MessagingBody) GetText

func (m MessagingBody) GetText() string

type MessagingMedia

type MessagingMedia struct {
	// url: Media URL
	// OptionalAttributes: additional attributes
	Url                string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

MessagingMedia <Media> TwiML Noun

func (MessagingMedia) GetAttr

func (m MessagingMedia) GetAttr() (map[string]string, map[string]string)

func (MessagingMedia) GetInnerElements

func (m MessagingMedia) GetInnerElements() []Element

func (MessagingMedia) GetName

func (m MessagingMedia) GetName() string

func (MessagingMedia) GetText

func (m MessagingMedia) GetText() string

type MessagingMessage

type MessagingMessage struct {
	// body: Message Body
	// to: Phone Number to send Message to
	// from: Phone Number to send Message from
	// action: Action URL
	// method: Action URL Method
	// status_callback: Status callback URL. Deprecated in favor of action.
	// OptionalAttributes: additional attributes
	Body               string
	To                 string
	From               string
	Action             string
	Method             string
	StatusCallback     string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

MessagingMessage <Message> TwiML Verb

func (MessagingMessage) GetAttr

func (m MessagingMessage) GetAttr() (map[string]string, map[string]string)

func (MessagingMessage) GetInnerElements

func (m MessagingMessage) GetInnerElements() []Element

func (MessagingMessage) GetName

func (m MessagingMessage) GetName() string

func (MessagingMessage) GetText

func (m MessagingMessage) GetText() string

type MessagingRedirect

type MessagingRedirect struct {
	// url: Redirect URL
	// method: Redirect URL method
	// OptionalAttributes: additional attributes
	Url                string
	Method             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

MessagingRedirect <Redirect> TwiML Verb

func (MessagingRedirect) GetAttr

func (m MessagingRedirect) GetAttr() (map[string]string, map[string]string)

func (MessagingRedirect) GetInnerElements

func (m MessagingRedirect) GetInnerElements() []Element

func (MessagingRedirect) GetName

func (m MessagingRedirect) GetName() string

func (MessagingRedirect) GetText

func (m MessagingRedirect) GetText() string

type VoiceApplication added in v1.3.2

type VoiceApplication struct {
	// application_sid: Application sid
	// url: TwiML URL
	// method: TwiML URL Method
	// status_callback_event: Events to trigger status callback
	// status_callback: Status Callback URL
	// status_callback_method: Status Callback URL Method
	// customer_id: Identity of the customer calling application
	// copy_parent_to: Copy parent call To field to called application side, otherwise use the application sid as To field
	// OptionalAttributes: additional attributes
	ApplicationSid       string
	Url                  string
	Method               string
	StatusCallbackEvent  string
	StatusCallback       string
	StatusCallbackMethod string
	CustomerId           string
	CopyParentTo         string
	InnerElements        []Element
	OptionalAttributes   map[string]string
}

VoiceApplication <Application> TwiML Noun

func (VoiceApplication) GetAttr added in v1.3.2

func (m VoiceApplication) GetAttr() (map[string]string, map[string]string)

func (VoiceApplication) GetInnerElements added in v1.3.2

func (m VoiceApplication) GetInnerElements() []Element

func (VoiceApplication) GetName added in v1.3.2

func (m VoiceApplication) GetName() string

func (VoiceApplication) GetText added in v1.3.2

func (m VoiceApplication) GetText() string

type VoiceApplicationSid added in v1.3.2

type VoiceApplicationSid struct {
	// sid: Application sid to dial
	// OptionalAttributes: additional attributes
	Sid                string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceApplicationSid <ApplicationSid> TwiML Noun

func (VoiceApplicationSid) GetAttr added in v1.3.2

func (m VoiceApplicationSid) GetAttr() (map[string]string, map[string]string)

func (VoiceApplicationSid) GetInnerElements added in v1.3.2

func (m VoiceApplicationSid) GetInnerElements() []Element

func (VoiceApplicationSid) GetName added in v1.3.2

func (m VoiceApplicationSid) GetName() string

func (VoiceApplicationSid) GetText added in v1.3.2

func (m VoiceApplicationSid) GetText() string

type VoiceAutopilot

type VoiceAutopilot struct {
	// name: Autopilot assistant sid or unique name
	// OptionalAttributes: additional attributes
	Name               string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceAutopilot <Autopilot> TwiML Noun

func (VoiceAutopilot) GetAttr

func (m VoiceAutopilot) GetAttr() (map[string]string, map[string]string)

func (VoiceAutopilot) GetInnerElements

func (m VoiceAutopilot) GetInnerElements() []Element

func (VoiceAutopilot) GetName

func (m VoiceAutopilot) GetName() string

func (VoiceAutopilot) GetText

func (m VoiceAutopilot) GetText() string

type VoiceBreak

type VoiceBreak struct {
	// strength: Set a pause based on strength
	// time: Set a pause to a specific length of time in seconds or milliseconds, available values: [number]s, [number]ms
	// OptionalAttributes: additional attributes
	Strength           string
	Time               string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceBreak Adding a Pause in <Say>

func (VoiceBreak) GetAttr

func (m VoiceBreak) GetAttr() (map[string]string, map[string]string)

func (VoiceBreak) GetInnerElements

func (m VoiceBreak) GetInnerElements() []Element

func (VoiceBreak) GetName

func (m VoiceBreak) GetName() string

func (VoiceBreak) GetText

func (m VoiceBreak) GetText() string

type VoiceClient

type VoiceClient struct {
	// identity: Client identity
	// url: Client URL
	// method: Client URL Method
	// status_callback_event: Events to trigger status callback
	// status_callback: Status Callback URL
	// status_callback_method: Status Callback URL Method
	// OptionalAttributes: additional attributes
	Identity             string
	Url                  string
	Method               string
	StatusCallbackEvent  string
	StatusCallback       string
	StatusCallbackMethod string
	InnerElements        []Element
	OptionalAttributes   map[string]string
}

VoiceClient <Client> TwiML Noun

func (VoiceClient) GetAttr

func (m VoiceClient) GetAttr() (map[string]string, map[string]string)

func (VoiceClient) GetInnerElements

func (m VoiceClient) GetInnerElements() []Element

func (VoiceClient) GetName

func (m VoiceClient) GetName() string

func (VoiceClient) GetText

func (m VoiceClient) GetText() string

type VoiceConference

type VoiceConference struct {
	// name: Conference name
	// muted: Join the conference muted
	// beep: Play beep when joining
	// start_conference_on_enter: Start the conference on enter
	// end_conference_on_exit: End the conferenceon exit
	// wait_url: Wait URL
	// wait_method: Wait URL method
	// max_participants: Maximum number of participants
	// record: Record the conference
	// region: Conference region
	// coach: Call coach
	// trim: Trim the conference recording
	// status_callback_event: Events to call status callback URL
	// status_callback: Status callback URL
	// status_callback_method: Status callback URL method
	// recording_status_callback: Recording status callback URL
	// recording_status_callback_method: Recording status callback URL method
	// recording_status_callback_event: Recording status callback events
	// event_callback_url: Event callback URL
	// jitter_buffer_size: Size of jitter buffer for participant
	// participant_label: A label for participant
	// OptionalAttributes: additional attributes
	Name                          string
	Muted                         string
	Beep                          string
	StartConferenceOnEnter        string
	EndConferenceOnExit           string
	WaitUrl                       string
	WaitMethod                    string
	MaxParticipants               string
	Record                        string
	Region                        string
	Coach                         string
	Trim                          string
	StatusCallbackEvent           string
	StatusCallback                string
	StatusCallbackMethod          string
	RecordingStatusCallback       string
	RecordingStatusCallbackMethod string
	RecordingStatusCallbackEvent  string
	EventCallbackUrl              string
	JitterBufferSize              string
	ParticipantLabel              string
	InnerElements                 []Element
	OptionalAttributes            map[string]string
}

VoiceConference <Conference> TwiML Noun

func (VoiceConference) GetAttr

func (m VoiceConference) GetAttr() (map[string]string, map[string]string)

func (VoiceConference) GetInnerElements

func (m VoiceConference) GetInnerElements() []Element

func (VoiceConference) GetName

func (m VoiceConference) GetName() string

func (VoiceConference) GetText

func (m VoiceConference) GetText() string

type VoiceConfig

type VoiceConfig struct {
	// name: The name of the custom config
	// value: The value of the custom config
	// OptionalAttributes: additional attributes
	Name               string
	Value              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceConfig <Config> TwiML Noun

func (VoiceConfig) GetAttr

func (m VoiceConfig) GetAttr() (map[string]string, map[string]string)

func (VoiceConfig) GetInnerElements

func (m VoiceConfig) GetInnerElements() []Element

func (VoiceConfig) GetName

func (m VoiceConfig) GetName() string

func (VoiceConfig) GetText

func (m VoiceConfig) GetText() string

type VoiceConnect

type VoiceConnect struct {
	// action: Action URL
	// method: Action URL method
	// OptionalAttributes: additional attributes
	Action             string
	Method             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceConnect <Connect> TwiML Verb

func (VoiceConnect) GetAttr

func (m VoiceConnect) GetAttr() (map[string]string, map[string]string)

func (VoiceConnect) GetInnerElements

func (m VoiceConnect) GetInnerElements() []Element

func (VoiceConnect) GetName

func (m VoiceConnect) GetName() string

func (VoiceConnect) GetText

func (m VoiceConnect) GetText() string

type VoiceConversation

type VoiceConversation struct {
	// service_instance_sid: Service instance Sid
	// inbound_autocreation: Inbound autocreation
	// routing_assignment_timeout: Routing assignment timeout
	// inbound_timeout: Inbound timeout
	// url: TwiML URL
	// method: TwiML URL method
	// record: Record
	// trim: Trim
	// recording_status_callback: Recording status callback URL
	// recording_status_callback_method: Recording status callback URL method
	// recording_status_callback_event: Recording status callback events
	// status_callback: Status callback URL
	// status_callback_method: Status callback URL method
	// status_callback_event: Events to call status callback URL
	// OptionalAttributes: additional attributes
	ServiceInstanceSid            string
	InboundAutocreation           string
	RoutingAssignmentTimeout      string
	InboundTimeout                string
	Url                           string
	Method                        string
	Record                        string
	Trim                          string
	RecordingStatusCallback       string
	RecordingStatusCallbackMethod string
	RecordingStatusCallbackEvent  string
	StatusCallback                string
	StatusCallbackMethod          string
	StatusCallbackEvent           string
	InnerElements                 []Element
	OptionalAttributes            map[string]string
}

VoiceConversation <Conversation> TwiML Noun

func (VoiceConversation) GetAttr

func (m VoiceConversation) GetAttr() (map[string]string, map[string]string)

func (VoiceConversation) GetInnerElements

func (m VoiceConversation) GetInnerElements() []Element

func (VoiceConversation) GetName

func (m VoiceConversation) GetName() string

func (VoiceConversation) GetText

func (m VoiceConversation) GetText() string

type VoiceDial

type VoiceDial struct {
	// number: Phone number to dial
	// action: Action URL
	// method: Action URL method
	// timeout: Time to wait for answer
	// hangup_on_star: Hangup call on star press
	// time_limit: Max time length
	// caller_id: Caller ID to display
	// record: Record the call
	// trim: Trim the recording
	// recording_status_callback: Recording status callback URL
	// recording_status_callback_method: Recording status callback URL method
	// recording_status_callback_event: Recording status callback events
	// answer_on_bridge: Preserve the ringing behavior of the inbound call until the Dialed call picks up
	// ring_tone: Ringtone allows you to override the ringback tone that Twilio will play back to the caller while executing the Dial
	// recording_track: To indicate which audio track should be recorded
	// 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
	// refer_url: Webhook that will receive future SIP REFER requests
	// refer_method: The HTTP method to use for the refer Webhook
	// OptionalAttributes: additional attributes
	Number                        string
	Action                        string
	Method                        string
	Timeout                       string
	HangupOnStar                  string
	TimeLimit                     string
	CallerId                      string
	Record                        string
	Trim                          string
	RecordingStatusCallback       string
	RecordingStatusCallbackMethod string
	RecordingStatusCallbackEvent  string
	AnswerOnBridge                string
	RingTone                      string
	RecordingTrack                string
	Sequential                    string
	ReferUrl                      string
	ReferMethod                   string
	InnerElements                 []Element
	OptionalAttributes            map[string]string
}

VoiceDial <Dial> TwiML Verb

func (VoiceDial) GetAttr

func (m VoiceDial) GetAttr() (map[string]string, map[string]string)

func (VoiceDial) GetInnerElements

func (m VoiceDial) GetInnerElements() []Element

func (VoiceDial) GetName

func (m VoiceDial) GetName() string

func (VoiceDial) GetText

func (m VoiceDial) GetText() string

type VoiceEcho

type VoiceEcho struct {
	// OptionalAttributes: additional attributes
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceEcho <Echo> TwiML Verb

func (VoiceEcho) GetAttr

func (m VoiceEcho) GetAttr() (map[string]string, map[string]string)

func (VoiceEcho) GetInnerElements

func (m VoiceEcho) GetInnerElements() []Element

func (VoiceEcho) GetName

func (m VoiceEcho) GetName() string

func (VoiceEcho) GetText

func (m VoiceEcho) GetText() string

type VoiceEmphasis

type VoiceEmphasis struct {
	// words: Words to emphasize
	// level: Specify the degree of emphasis
	// OptionalAttributes: additional attributes
	Words              string
	Level              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceEmphasis Emphasizing Words in <Say>

func (VoiceEmphasis) GetAttr

func (m VoiceEmphasis) GetAttr() (map[string]string, map[string]string)

func (VoiceEmphasis) GetInnerElements

func (m VoiceEmphasis) GetInnerElements() []Element

func (VoiceEmphasis) GetName

func (m VoiceEmphasis) GetName() string

func (VoiceEmphasis) GetText

func (m VoiceEmphasis) GetText() string

type VoiceEnqueue

type VoiceEnqueue struct {
	// name: Friendly name
	// action: Action URL
	// max_queue_size: Maximum size of queue
	// method: Action URL method
	// wait_url: Wait URL
	// wait_url_method: Wait URL method
	// workflow_sid: TaskRouter Workflow SID
	// OptionalAttributes: additional attributes
	Name               string
	Action             string
	MaxQueueSize       string
	Method             string
	WaitUrl            string
	WaitUrlMethod      string
	WorkflowSid        string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceEnqueue <Enqueue> TwiML Noun

func (VoiceEnqueue) GetAttr

func (m VoiceEnqueue) GetAttr() (map[string]string, map[string]string)

func (VoiceEnqueue) GetInnerElements

func (m VoiceEnqueue) GetInnerElements() []Element

func (VoiceEnqueue) GetName

func (m VoiceEnqueue) GetName() string

func (VoiceEnqueue) GetText

func (m VoiceEnqueue) GetText() string

type VoiceGather

type VoiceGather struct {
	// input: Input type Twilio should accept
	// action: Action URL
	// method: Action URL method
	// timeout: Time to wait to gather input
	// speech_timeout: Time to wait to gather speech input and it should be either auto or a positive integer.
	// max_speech_time: Max allowed time for speech input
	// profanity_filter: Profanity Filter on speech
	// finish_on_key: Finish gather on key
	// num_digits: Number of digits to collect
	// partial_result_callback: Partial result callback URL
	// partial_result_callback_method: Partial result callback URL method
	// language: Language to use
	// hints: Speech recognition hints
	// barge_in: Stop playing media upon speech
	// debug: Allow debug for gather
	// action_on_empty_result: Force webhook to the action URL event if there is no input
	// speech_model: Specify the model that is best suited for your use case
	// enhanced: Use enhanced speech model
	// OptionalAttributes: additional attributes
	Input                       string
	Action                      string
	Method                      string
	Timeout                     string
	SpeechTimeout               string
	MaxSpeechTime               string
	ProfanityFilter             string
	FinishOnKey                 string
	NumDigits                   string
	PartialResultCallback       string
	PartialResultCallbackMethod string
	Language                    string
	Hints                       string
	BargeIn                     string
	Debug                       string
	ActionOnEmptyResult         string
	SpeechModel                 string
	Enhanced                    string
	InnerElements               []Element
	OptionalAttributes          map[string]string
}

VoiceGather <Gather> TwiML Verb

func (VoiceGather) GetAttr

func (m VoiceGather) GetAttr() (map[string]string, map[string]string)

func (VoiceGather) GetInnerElements

func (m VoiceGather) GetInnerElements() []Element

func (VoiceGather) GetName

func (m VoiceGather) GetName() string

func (VoiceGather) GetText

func (m VoiceGather) GetText() string

type VoiceHangup

type VoiceHangup struct {
	// OptionalAttributes: additional attributes
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceHangup <Hangup> TwiML Verb

func (VoiceHangup) GetAttr

func (m VoiceHangup) GetAttr() (map[string]string, map[string]string)

func (VoiceHangup) GetInnerElements

func (m VoiceHangup) GetInnerElements() []Element

func (VoiceHangup) GetName

func (m VoiceHangup) GetName() string

func (VoiceHangup) GetText

func (m VoiceHangup) GetText() string

type VoiceIdentity

type VoiceIdentity struct {
	// client_identity: Identity of the client to dial
	// OptionalAttributes: additional attributes
	ClientIdentity     string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceIdentity <Identity> TwiML Noun

func (VoiceIdentity) GetAttr

func (m VoiceIdentity) GetAttr() (map[string]string, map[string]string)

func (VoiceIdentity) GetInnerElements

func (m VoiceIdentity) GetInnerElements() []Element

func (VoiceIdentity) GetName

func (m VoiceIdentity) GetName() string

func (VoiceIdentity) GetText

func (m VoiceIdentity) GetText() string

type VoiceLang

type VoiceLang struct {
	// words: Words to speak
	// xml:lang: Specify the language
	// OptionalAttributes: additional attributes
	Words              string
	XmlLang            string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceLang Specifying Another Language for Specific Words in <Say>

func (VoiceLang) GetAttr

func (m VoiceLang) GetAttr() (map[string]string, map[string]string)

func (VoiceLang) GetInnerElements

func (m VoiceLang) GetInnerElements() []Element

func (VoiceLang) GetName

func (m VoiceLang) GetName() string

func (VoiceLang) GetText

func (m VoiceLang) GetText() string

type VoiceLeave

type VoiceLeave struct {
	// OptionalAttributes: additional attributes
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceLeave <Leave> TwiML Verb

func (VoiceLeave) GetAttr

func (m VoiceLeave) GetAttr() (map[string]string, map[string]string)

func (VoiceLeave) GetInnerElements

func (m VoiceLeave) GetInnerElements() []Element

func (VoiceLeave) GetName

func (m VoiceLeave) GetName() string

func (VoiceLeave) GetText

func (m VoiceLeave) GetText() string

type VoiceNumber

type VoiceNumber struct {
	// phone_number: Phone Number to dial
	// send_digits: DTMF tones to play when the call is answered
	// url: TwiML URL
	// method: TwiML URL method
	// status_callback_event: Events to call status callback
	// status_callback: Status callback URL
	// status_callback_method: Status callback URL method
	// byoc: BYOC trunk SID (Beta)
	// machine_detection: Enable machine detection or end of greeting detection
	// amd_status_callback_method: HTTP Method to use with amd_status_callback
	// amd_status_callback: The URL we should call to send amd status information to your application
	// machine_detection_timeout: Number of seconds to wait for machine detection
	// machine_detection_speech_threshold: Number of milliseconds for measuring stick for the length of the speech activity
	// machine_detection_speech_end_threshold: Number of milliseconds of silence after speech activity
	// machine_detection_silence_timeout: Number of milliseconds of initial silence
	// OptionalAttributes: additional attributes
	PhoneNumber                        string
	SendDigits                         string
	Url                                string
	Method                             string
	StatusCallbackEvent                string
	StatusCallback                     string
	StatusCallbackMethod               string
	Byoc                               string
	MachineDetection                   string
	AmdStatusCallbackMethod            string
	AmdStatusCallback                  string
	MachineDetectionTimeout            string
	MachineDetectionSpeechThreshold    string
	MachineDetectionSpeechEndThreshold string
	MachineDetectionSilenceTimeout     string
	InnerElements                      []Element
	OptionalAttributes                 map[string]string
}

VoiceNumber <Number> TwiML Noun

func (VoiceNumber) GetAttr

func (m VoiceNumber) GetAttr() (map[string]string, map[string]string)

func (VoiceNumber) GetInnerElements

func (m VoiceNumber) GetInnerElements() []Element

func (VoiceNumber) GetName

func (m VoiceNumber) GetName() string

func (VoiceNumber) GetText

func (m VoiceNumber) GetText() string

type VoiceP

type VoiceP struct {
	// words: Words to speak
	// OptionalAttributes: additional attributes
	Words              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceP Adding a Pause Between Paragraphs in <Say>

func (VoiceP) GetAttr

func (m VoiceP) GetAttr() (map[string]string, map[string]string)

func (VoiceP) GetInnerElements

func (m VoiceP) GetInnerElements() []Element

func (VoiceP) GetName

func (m VoiceP) GetName() string

func (VoiceP) GetText

func (m VoiceP) GetText() string

type VoiceParameter

type VoiceParameter struct {
	// name: The name of the custom parameter
	// value: The value of the custom parameter
	// OptionalAttributes: additional attributes
	Name               string
	Value              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceParameter <Parameter> TwiML Noun

func (VoiceParameter) GetAttr

func (m VoiceParameter) GetAttr() (map[string]string, map[string]string)

func (VoiceParameter) GetInnerElements

func (m VoiceParameter) GetInnerElements() []Element

func (VoiceParameter) GetName

func (m VoiceParameter) GetName() string

func (VoiceParameter) GetText

func (m VoiceParameter) GetText() string

type VoicePause

type VoicePause struct {
	// length: Length in seconds to pause
	// OptionalAttributes: additional attributes
	Length             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoicePause <Pause> TwiML Verb

func (VoicePause) GetAttr

func (m VoicePause) GetAttr() (map[string]string, map[string]string)

func (VoicePause) GetInnerElements

func (m VoicePause) GetInnerElements() []Element

func (VoicePause) GetName

func (m VoicePause) GetName() string

func (VoicePause) GetText

func (m VoicePause) GetText() string

type VoicePay

type VoicePay struct {
	// input: Input type Twilio should accept
	// action: Action URL
	// 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
	// status_callback: Status callback URL
	// status_callback_method: Status callback method
	// timeout: Time to wait to gather input
	// max_attempts: Maximum number of allowed retries when gathering input
	// security_code: Prompt for security code
	// postal_code: Prompt for postal code and it should be true/false or default postal code
	// min_postal_code_length: Prompt for minimum postal code length
	// payment_connector: Unique name for payment connector
	// payment_method: Payment method to be used. defaults to credit-card
	// token_type: Type of token
	// charge_amount: Amount to process. If value is greater than 0 then make the payment else create a payment token
	// currency: Currency of the amount attribute
	// description: Details regarding the payment
	// valid_card_types: Comma separated accepted card types
	// language: Language to use
	// OptionalAttributes: additional attributes
	Input                string
	Action               string
	BankAccountType      string
	StatusCallback       string
	StatusCallbackMethod string
	Timeout              string
	MaxAttempts          string
	SecurityCode         string
	PostalCode           string
	MinPostalCodeLength  string
	PaymentConnector     string
	PaymentMethod        string
	TokenType            string
	ChargeAmount         string
	Currency             string
	Description          string
	ValidCardTypes       string
	Language             string
	InnerElements        []Element
	OptionalAttributes   map[string]string
}

VoicePay <Pay> Twiml Verb

func (VoicePay) GetAttr

func (m VoicePay) GetAttr() (map[string]string, map[string]string)

func (VoicePay) GetInnerElements

func (m VoicePay) GetInnerElements() []Element

func (VoicePay) GetName

func (m VoicePay) GetName() string

func (VoicePay) GetText

func (m VoicePay) GetText() string

type VoicePhoneme

type VoicePhoneme struct {
	// words: Words to speak
	// alphabet: Specify the phonetic alphabet
	// ph: Specifiy the phonetic symbols for pronunciation
	// OptionalAttributes: additional attributes
	Words              string
	Alphabet           string
	Ph                 string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoicePhoneme Using Phonetic Pronunciation in <Say>

func (VoicePhoneme) GetAttr

func (m VoicePhoneme) GetAttr() (map[string]string, map[string]string)

func (VoicePhoneme) GetInnerElements

func (m VoicePhoneme) GetInnerElements() []Element

func (VoicePhoneme) GetName

func (m VoicePhoneme) GetName() string

func (VoicePhoneme) GetText

func (m VoicePhoneme) GetText() string

type VoicePlay

type VoicePlay struct {
	// url: Media URL
	// loop: Times to loop media
	// digits: Play DTMF tones for digits
	// OptionalAttributes: additional attributes
	Url                string
	Loop               string
	Digits             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoicePlay <Play> TwiML Verb

func (VoicePlay) GetAttr

func (m VoicePlay) GetAttr() (map[string]string, map[string]string)

func (VoicePlay) GetInnerElements

func (m VoicePlay) GetInnerElements() []Element

func (VoicePlay) GetName

func (m VoicePlay) GetName() string

func (VoicePlay) GetText

func (m VoicePlay) GetText() string

type VoicePrompt

type VoicePrompt struct {
	// for_: Name of the payment source data element
	// error_type: Type of error
	// card_type: Type of the credit card
	// attempt: Current attempt count
	// require_matching_inputs: Require customer to input requested information twice and verify matching.
	// OptionalAttributes: additional attributes
	For_                  string
	ErrorType             string
	CardType              string
	Attempt               string
	RequireMatchingInputs string
	InnerElements         []Element
	OptionalAttributes    map[string]string
}

VoicePrompt <Prompt> Twiml Verb

func (VoicePrompt) GetAttr

func (m VoicePrompt) GetAttr() (map[string]string, map[string]string)

func (VoicePrompt) GetInnerElements

func (m VoicePrompt) GetInnerElements() []Element

func (VoicePrompt) GetName

func (m VoicePrompt) GetName() string

func (VoicePrompt) GetText

func (m VoicePrompt) GetText() string

type VoiceProsody

type VoiceProsody struct {
	// words: Words to speak
	// volume: Specify the volume, available values: default, silent, x-soft, soft, medium, loud, x-loud, +ndB, -ndB
	// rate: Specify the rate, available values: x-slow, slow, medium, fast, x-fast, n%
	// pitch: Specify the pitch, available values: default, x-low, low, medium, high, x-high, +n%, -n%
	// OptionalAttributes: additional attributes
	Words              string
	Volume             string
	Rate               string
	Pitch              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceProsody Controling Volume, Speaking Rate, and Pitch in <Say>

func (VoiceProsody) GetAttr

func (m VoiceProsody) GetAttr() (map[string]string, map[string]string)

func (VoiceProsody) GetInnerElements

func (m VoiceProsody) GetInnerElements() []Element

func (VoiceProsody) GetName

func (m VoiceProsody) GetName() string

func (VoiceProsody) GetText

func (m VoiceProsody) GetText() string

type VoiceQueue

type VoiceQueue struct {
	// name: Queue name
	// url: Action URL
	// method: Action URL method
	// reservation_sid: TaskRouter Reservation SID
	// post_work_activity_sid: TaskRouter Activity SID
	// OptionalAttributes: additional attributes
	Name                string
	Url                 string
	Method              string
	ReservationSid      string
	PostWorkActivitySid string
	InnerElements       []Element
	OptionalAttributes  map[string]string
}

VoiceQueue <Queue> TwiML Noun

func (VoiceQueue) GetAttr

func (m VoiceQueue) GetAttr() (map[string]string, map[string]string)

func (VoiceQueue) GetInnerElements

func (m VoiceQueue) GetInnerElements() []Element

func (VoiceQueue) GetName

func (m VoiceQueue) GetName() string

func (VoiceQueue) GetText

func (m VoiceQueue) GetText() string

type VoiceRecord

type VoiceRecord struct {
	// action: Action URL
	// method: Action URL method
	// timeout: Timeout to begin recording
	// finish_on_key: Finish recording on key
	// max_length: Max time to record in seconds
	// play_beep: Play beep
	// trim: Trim the recording
	// recording_status_callback: Status callback URL
	// recording_status_callback_method: Status callback URL method
	// recording_status_callback_event: Recording status callback events
	// transcribe: Transcribe the recording
	// transcribe_callback: Transcribe callback URL
	// OptionalAttributes: additional attributes
	Action                        string
	Method                        string
	Timeout                       string
	FinishOnKey                   string
	MaxLength                     string
	PlayBeep                      string
	Trim                          string
	RecordingStatusCallback       string
	RecordingStatusCallbackMethod string
	RecordingStatusCallbackEvent  string
	Transcribe                    string
	TranscribeCallback            string
	InnerElements                 []Element
	OptionalAttributes            map[string]string
}

VoiceRecord <Record> TwiML Verb

func (VoiceRecord) GetAttr

func (m VoiceRecord) GetAttr() (map[string]string, map[string]string)

func (VoiceRecord) GetInnerElements

func (m VoiceRecord) GetInnerElements() []Element

func (VoiceRecord) GetName

func (m VoiceRecord) GetName() string

func (VoiceRecord) GetText

func (m VoiceRecord) GetText() string

type VoiceRedirect

type VoiceRedirect struct {
	// url: Redirect URL
	// method: Redirect URL method
	// OptionalAttributes: additional attributes
	Url                string
	Method             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceRedirect <Redirect> TwiML Verb

func (VoiceRedirect) GetAttr

func (m VoiceRedirect) GetAttr() (map[string]string, map[string]string)

func (VoiceRedirect) GetInnerElements

func (m VoiceRedirect) GetInnerElements() []Element

func (VoiceRedirect) GetName

func (m VoiceRedirect) GetName() string

func (VoiceRedirect) GetText

func (m VoiceRedirect) GetText() string

type VoiceRefer

type VoiceRefer struct {
	// action: Action URL
	// method: Action URL method
	// OptionalAttributes: additional attributes
	Action             string
	Method             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceRefer <Refer> TwiML Verb

func (VoiceRefer) GetAttr

func (m VoiceRefer) GetAttr() (map[string]string, map[string]string)

func (VoiceRefer) GetInnerElements

func (m VoiceRefer) GetInnerElements() []Element

func (VoiceRefer) GetName

func (m VoiceRefer) GetName() string

func (VoiceRefer) GetText

func (m VoiceRefer) GetText() string

type VoiceReferSip

type VoiceReferSip struct {
	// sip_url: SIP URL
	// OptionalAttributes: additional attributes
	SipUrl             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceReferSip <Sip> TwiML Noun used in <Refer>

func (VoiceReferSip) GetAttr

func (m VoiceReferSip) GetAttr() (map[string]string, map[string]string)

func (VoiceReferSip) GetInnerElements

func (m VoiceReferSip) GetInnerElements() []Element

func (VoiceReferSip) GetName

func (m VoiceReferSip) GetName() string

func (VoiceReferSip) GetText

func (m VoiceReferSip) GetText() string

type VoiceReject

type VoiceReject struct {
	// reason: Rejection reason
	// OptionalAttributes: additional attributes
	Reason             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceReject <Reject> TwiML Verb

func (VoiceReject) GetAttr

func (m VoiceReject) GetAttr() (map[string]string, map[string]string)

func (VoiceReject) GetInnerElements

func (m VoiceReject) GetInnerElements() []Element

func (VoiceReject) GetName

func (m VoiceReject) GetName() string

func (VoiceReject) GetText

func (m VoiceReject) GetText() string

type VoiceRoom

type VoiceRoom struct {
	// name: Room name
	// participant_identity: Participant identity when connecting to the Room
	// OptionalAttributes: additional attributes
	Name                string
	ParticipantIdentity string
	InnerElements       []Element
	OptionalAttributes  map[string]string
}

VoiceRoom <Room> TwiML Noun

func (VoiceRoom) GetAttr

func (m VoiceRoom) GetAttr() (map[string]string, map[string]string)

func (VoiceRoom) GetInnerElements

func (m VoiceRoom) GetInnerElements() []Element

func (VoiceRoom) GetName

func (m VoiceRoom) GetName() string

func (VoiceRoom) GetText

func (m VoiceRoom) GetText() string

type VoiceS

type VoiceS struct {
	// words: Words to speak
	// OptionalAttributes: additional attributes
	Words              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceS Adding A Pause Between Sentences in <Say>

func (VoiceS) GetAttr

func (m VoiceS) GetAttr() (map[string]string, map[string]string)

func (VoiceS) GetInnerElements

func (m VoiceS) GetInnerElements() []Element

func (VoiceS) GetName

func (m VoiceS) GetName() string

func (VoiceS) GetText

func (m VoiceS) GetText() string

type VoiceSay

type VoiceSay struct {
	// message: Message to say
	// voice: Voice to use
	// loop: Times to loop message
	// language: Message language
	// OptionalAttributes: additional attributes
	Message            string
	Voice              string
	Loop               string
	Language           string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSay <Say> TwiML Verb

func (VoiceSay) GetAttr

func (m VoiceSay) GetAttr() (map[string]string, map[string]string)

func (VoiceSay) GetInnerElements

func (m VoiceSay) GetInnerElements() []Element

func (VoiceSay) GetName

func (m VoiceSay) GetName() string

func (VoiceSay) GetText

func (m VoiceSay) GetText() string

type VoiceSayAs

type VoiceSayAs struct {
	// words: Words to be interpreted
	// interpret-as: Specify the type of words are spoken
	// format: Specify the format of the date when interpret-as is set to date
	// OptionalAttributes: additional attributes
	Words              string
	InterpretAs        string
	Format             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSayAs Controlling How Special Types of Words Are Spoken in <Say>

func (VoiceSayAs) GetAttr

func (m VoiceSayAs) GetAttr() (map[string]string, map[string]string)

func (VoiceSayAs) GetInnerElements

func (m VoiceSayAs) GetInnerElements() []Element

func (VoiceSayAs) GetName

func (m VoiceSayAs) GetName() string

func (VoiceSayAs) GetText

func (m VoiceSayAs) GetText() string

type VoiceSim

type VoiceSim struct {
	// sim_sid: SIM SID
	// OptionalAttributes: additional attributes
	SimSid             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSim <Sim> TwiML Noun

func (VoiceSim) GetAttr

func (m VoiceSim) GetAttr() (map[string]string, map[string]string)

func (VoiceSim) GetInnerElements

func (m VoiceSim) GetInnerElements() []Element

func (VoiceSim) GetName

func (m VoiceSim) GetName() string

func (VoiceSim) GetText

func (m VoiceSim) GetText() string

type VoiceSip

type VoiceSip struct {
	// sip_url: SIP URL
	// username: SIP Username
	// password: SIP Password
	// url: Action URL
	// method: Action URL method
	// status_callback_event: Status callback events
	// status_callback: Status callback URL
	// status_callback_method: Status callback URL method
	// machine_detection: Enable machine detection or end of greeting detection
	// amd_status_callback_method: HTTP Method to use with amd_status_callback
	// amd_status_callback: The URL we should call to send amd status information to your application
	// machine_detection_timeout: Number of seconds to wait for machine detection
	// machine_detection_speech_threshold: Number of milliseconds for measuring stick for the length of the speech activity
	// machine_detection_speech_end_threshold: Number of milliseconds of silence after speech activity
	// machine_detection_silence_timeout: Number of milliseconds of initial silence
	// OptionalAttributes: additional attributes
	SipUrl                             string
	Username                           string
	Password                           string
	Url                                string
	Method                             string
	StatusCallbackEvent                string
	StatusCallback                     string
	StatusCallbackMethod               string
	MachineDetection                   string
	AmdStatusCallbackMethod            string
	AmdStatusCallback                  string
	MachineDetectionTimeout            string
	MachineDetectionSpeechThreshold    string
	MachineDetectionSpeechEndThreshold string
	MachineDetectionSilenceTimeout     string
	InnerElements                      []Element
	OptionalAttributes                 map[string]string
}

VoiceSip <Sip> TwiML Noun

func (VoiceSip) GetAttr

func (m VoiceSip) GetAttr() (map[string]string, map[string]string)

func (VoiceSip) GetInnerElements

func (m VoiceSip) GetInnerElements() []Element

func (VoiceSip) GetName

func (m VoiceSip) GetName() string

func (VoiceSip) GetText

func (m VoiceSip) GetText() string

type VoiceSipRec

type VoiceSipRec struct {
	// name: Friendly name given to SIPREC
	// connector_name: Unique name for Connector
	// track: Track to be streamed to remote service
	// OptionalAttributes: additional attributes
	Name               string
	ConnectorName      string
	Track              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSipRec <Siprec> TwiML Noun

func (VoiceSipRec) GetAttr

func (m VoiceSipRec) GetAttr() (map[string]string, map[string]string)

func (VoiceSipRec) GetInnerElements

func (m VoiceSipRec) GetInnerElements() []Element

func (VoiceSipRec) GetName

func (m VoiceSipRec) GetName() string

func (VoiceSipRec) GetText

func (m VoiceSipRec) GetText() string

type VoiceSms

type VoiceSms struct {
	// message: Message body
	// to: Number to send message to
	// from: Number to send message from
	// action: Action URL
	// method: Action URL method
	// status_callback: Status callback URL
	// OptionalAttributes: additional attributes
	Message            string
	To                 string
	From               string
	Action             string
	Method             string
	StatusCallback     string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSms <Sms> TwiML Noun

func (VoiceSms) GetAttr

func (m VoiceSms) GetAttr() (map[string]string, map[string]string)

func (VoiceSms) GetInnerElements

func (m VoiceSms) GetInnerElements() []Element

func (VoiceSms) GetName

func (m VoiceSms) GetName() string

func (VoiceSms) GetText

func (m VoiceSms) GetText() string

type VoiceStart

type VoiceStart struct {
	// action: Action URL
	// method: Action URL method
	// OptionalAttributes: additional attributes
	Action             string
	Method             string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceStart <Start> TwiML Verb

func (VoiceStart) GetAttr

func (m VoiceStart) GetAttr() (map[string]string, map[string]string)

func (VoiceStart) GetInnerElements

func (m VoiceStart) GetInnerElements() []Element

func (VoiceStart) GetName

func (m VoiceStart) GetName() string

func (VoiceStart) GetText

func (m VoiceStart) GetText() string

type VoiceStop

type VoiceStop struct {
	// OptionalAttributes: additional attributes
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceStop <Stop> TwiML Verb

func (VoiceStop) GetAttr

func (m VoiceStop) GetAttr() (map[string]string, map[string]string)

func (VoiceStop) GetInnerElements

func (m VoiceStop) GetInnerElements() []Element

func (VoiceStop) GetName

func (m VoiceStop) GetName() string

func (VoiceStop) GetText

func (m VoiceStop) GetText() string

type VoiceStream

type VoiceStream struct {
	// name: Friendly name given to the Stream
	// connector_name: Unique name for Stream Connector
	// url: URL of the remote service where the Stream is routed
	// track: Track to be streamed to remote service
	// status_callback: Status Callback URL
	// status_callback_method: Status Callback URL method
	// OptionalAttributes: additional attributes
	Name                 string
	ConnectorName        string
	Url                  string
	Track                string
	StatusCallback       string
	StatusCallbackMethod string
	InnerElements        []Element
	OptionalAttributes   map[string]string
}

VoiceStream <Stream> TwiML Noun

func (VoiceStream) GetAttr

func (m VoiceStream) GetAttr() (map[string]string, map[string]string)

func (VoiceStream) GetInnerElements

func (m VoiceStream) GetInnerElements() []Element

func (VoiceStream) GetName

func (m VoiceStream) GetName() string

func (VoiceStream) GetText

func (m VoiceStream) GetText() string

type VoiceSub

type VoiceSub struct {
	// words: Words to be substituted
	// alias: Substitute a different word (or pronunciation) for selected text such as an acronym or abbreviation
	// OptionalAttributes: additional attributes
	Words              string
	Alias              string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceSub Pronouncing Acronyms and Abbreviations in <Say>

func (VoiceSub) GetAttr

func (m VoiceSub) GetAttr() (map[string]string, map[string]string)

func (VoiceSub) GetInnerElements

func (m VoiceSub) GetInnerElements() []Element

func (VoiceSub) GetName

func (m VoiceSub) GetName() string

func (VoiceSub) GetText

func (m VoiceSub) GetText() string

type VoiceTask

type VoiceTask struct {
	// body: TaskRouter task attributes
	// priority: Task priority
	// timeout: Timeout associated with task
	// OptionalAttributes: additional attributes
	Body               string
	Priority           string
	Timeout            string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceTask <Task> TwiML Noun

func (VoiceTask) GetAttr

func (m VoiceTask) GetAttr() (map[string]string, map[string]string)

func (VoiceTask) GetInnerElements

func (m VoiceTask) GetInnerElements() []Element

func (VoiceTask) GetName

func (m VoiceTask) GetName() string

func (VoiceTask) GetText

func (m VoiceTask) GetText() string

type VoiceVirtualAgent

type VoiceVirtualAgent struct {
	// connector_name: Defines the conversation profile Dialogflow needs to use
	// language: Language to be used by Dialogflow to transcribe speech
	// sentiment_analysis: Whether sentiment analysis needs to be enabled or not
	// status_callback: URL to post status callbacks from Twilio
	// status_callback_method: HTTP method to use when requesting the status callback URL
	// OptionalAttributes: additional attributes
	ConnectorName        string
	Language             string
	SentimentAnalysis    string
	StatusCallback       string
	StatusCallbackMethod string
	InnerElements        []Element
	OptionalAttributes   map[string]string
}

VoiceVirtualAgent <VirtualAgent> TwiML Noun

func (VoiceVirtualAgent) GetAttr

func (m VoiceVirtualAgent) GetAttr() (map[string]string, map[string]string)

func (VoiceVirtualAgent) GetInnerElements

func (m VoiceVirtualAgent) GetInnerElements() []Element

func (VoiceVirtualAgent) GetName

func (m VoiceVirtualAgent) GetName() string

func (VoiceVirtualAgent) GetText

func (m VoiceVirtualAgent) GetText() string

type VoiceW

type VoiceW struct {
	// words: Words to speak
	// role: Customize the pronunciation of words by specifying the word’s part of speech or alternate meaning
	// OptionalAttributes: additional attributes
	Words              string
	Role               string
	InnerElements      []Element
	OptionalAttributes map[string]string
}

VoiceW Improving Pronunciation by Specifying Parts of Speech in <Say>

func (VoiceW) GetAttr

func (m VoiceW) GetAttr() (map[string]string, map[string]string)

func (VoiceW) GetInnerElements

func (m VoiceW) GetInnerElements() []Element

func (VoiceW) GetName

func (m VoiceW) GetName() string

func (VoiceW) GetText

func (m VoiceW) GetText() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL