Element details

type: meya.twilio.voice.event.gather
class: TwilioVoiceGatherEvent
path: /meya/twilio/voice/event/gather.py
signature: -

Fields

field	required	signature	default	type
parent_entry_ref	○	○	null	EntryRef
trace_id	○	○	"-"	str
sensitive	○	○	false	bool
internal	○	○	false	bool
user_id	◉	○		str
thread_id	◉	○		str
integration_id	◉	○		str
context	○	○	{}	dict
composer	○	○	focus: placeholder: collapse_placeholder: visibility: character_limit:	ComposerEventSpec
quick_replies	○	○	[]	list
header	○	○	buttons: title: progress: milestones: extra_buttons:	HeaderEventSpec
markdown	○	○	[]	list
text	○	○		str
input	◉	○		GatherInput
timeout	○	○	null	timedelta
profanity_filter	○	○	null	bool
finish_on_key	○	○	null	str
num_digits	○	○	null	int
language	○	○	null	str
hints	○	○	null	str
speech_timeout	○	○	null	timedelta
speech_model	○	○	null	SpeechModel
enhanced	○	○	null	bool

Usage reference

Data

{
    "type": "meya.twilio.voice.event.gather", 
    "data": {
        "parent_entry_ref": {
            "ledger": "STRING", 
            "id": "STRING", 
            "data": {
                "STRING": "STRING"
            }
        }, 
        "trace_id": "STRING", 
        "sensitive": false, 
        "internal": false, 
        "user_id": "STRING", 
        "thread_id": "STRING", 
        "integration_id": "STRING", 
        "context": {
            "STRING": "ANY"
        }, 
        "composer": {
            "focus": "file|image|text|blur", 
            "placeholder": "STRING", 
            "collapse_placeholder": "STRING", 
            "visibility": "collapse|hide|show", 
            "character_limit": {
                "length": 123, 
                "error_text": "STRING"
            }
        }, 
        "quick_replies": [
            {
                "url": "STRING", 
                "javascript": "STRING", 
                "button_id": "STRING", 
                "context": {
                    "STRING": "ANY"
                }, 
                "default": false, 
                "disabled": false, 
                "divider": false, 
                "icon": {
                    "url": "STRING", 
                    "color": "STRING"
                }, 
                "menu": [
                    "BUTTONEVENTSPEC"
                ], 
                "text": "STRING"
            }
        ], 
        "header": {
            "buttons": [
                {
                    "url": "STRING", 
                    "javascript": "STRING", 
                    "button_id": "STRING", 
                    "context": {
                        "STRING": "ANY"
                    }, 
                    "default": false, 
                    "disabled": false, 
                    "divider": false, 
                    "icon": {
                        "url": "STRING", 
                        "color": "STRING"
                    }, 
                    "menu": [
                        "BUTTONEVENTSPEC"
                    ], 
                    "text": "STRING"
                }
            ], 
            "title": {
                "text": "STRING", 
                "icon": {
                    "url": "STRING", 
                    "color": "STRING"
                }
            }, 
            "progress": {
                "value": 123, 
                "show_percent": false
            }, 
            "milestones": [
                {
                    "text": "STRING", 
                    "current": false
                }
            ], 
            "extra_buttons": [
                {
                    "url": "STRING", 
                    "javascript": "STRING", 
                    "button_id": "STRING", 
                    "context": {
                        "STRING": "ANY"
                    }, 
                    "default": false, 
                    "disabled": false, 
                    "divider": false, 
                    "icon": {
                        "url": "STRING", 
                        "color": "STRING"
                    }, 
                    "menu": [
                        "BUTTONEVENTSPEC"
                    ], 
                    "text": "STRING"
                }
            ]
        }, 
        "markdown": [
            "format|linkify|breaks|typographer"
        ], 
        "text": "STRING", 
        "input": "dtmf|speech|dtmf speech", 
        "timeout": "60s", 
        "profanity_filter": false, 
        "finish_on_key": "STRING", 
        "num_digits": 123, 
        "language": "STRING", 
        "hints": "STRING", 
        "speech_timeout": "60s", 
        "speech_model": "default|numbers_and_commands|phone_call", 
        "enhanced": false
    }
}