{ "sip:decline": { "properties": { "id": "string", "status": "number", "reason": "string", "headers": "object" }, "required": [ "status" ] }, "sip:request": { "properties": { "id": "string", "method": "string", "body": "string", "headers": "object", "actionHook": "object|string" }, "required": [ "method" ] }, "sip:refer": { "properties": { "id": "string", "referTo": "string", "referredBy": "string", "headers": "object", "actionHook": "object|string", "eventHook": "object|string" }, "required": [ "referTo" ] }, "config": { "properties": { "id": "string", "synthesizer": "#synthesizer", "recognizer": "#recognizer", "bargeIn": "#bargeIn", "record": "#recordOptions", "amd": "#amd", "notifyEvents": "boolean" }, "required": [] }, "bargeIn": { "properties": { "enable": "boolean", "sticky": "boolean", "actionHook": "object|string", "input": "array", "finishOnKey": "string", "numDigits": "number", "minDigits": "number", "maxDigits": "number", "interDigitTimeout": "number", "dtmfBargein": "boolean", "minBargeinWordCount": "number" }, "required": [ "enable" ] }, "dequeue": { "properties": { "id": "string", "name": "string", "actionHook": "object|string", "timeout": "number", "beep": "boolean" }, "required": [ "name" ] }, "enqueue": { "properties": { "id": "string", "name": "string", "actionHook": "object|string", "waitHook": "object|string", "_": "object" }, "required": [ "name" ] }, "leave": { "properties": { "id": "string" } }, "hangup": { "properties": { "id": "string", "headers": "object" }, "required": [ ] }, "play": { "properties": { "id": "string", "url": "string|array", "loop": "number|string", "earlyMedia": "boolean", "seekOffset": "number|string", "timeoutSecs": "number|string", "actionHook": "object|string" }, "required": [ "url" ] }, "say": { "properties": { "id": "string", "text": "string|array", "loop": "number|string", "synthesizer": "#synthesizer", "earlyMedia": "boolean", "disableTtsCache": "boolean" }, "required": [ "text" ] }, "gather": { "properties": { "id": "string", "actionHook": "object|string", "finishOnKey": "string", "input": "array", "numDigits": "number", "minDigits": "number", "maxDigits": "number", "interDigitTimeout": "number", "partialResultHook": "object|string", "speechTimeout": "number", "listenDuringPrompt": "boolean", "dtmfBargein": "boolean", "bargein": "boolean", "minBargeinWordCount": "number", "timeout": "number", "recognizer": "#recognizer", "play": "#play", "say": "#say" }, "required": [ ] }, "conference": { "properties": { "id": "string", "name": "string", "beep": "boolean", "startConferenceOnEnter": "boolean", "endConferenceOnExit": "boolean", "maxParticipants": "number", "joinMuted": "boolean", "actionHook": "object|string", "waitHook": "object|string", "statusEvents": "array", "statusHook": "object|string", "enterHook": "object|string", "record": "#record" }, "required": [ "name" ] }, "dial": { "properties": { "id": "string", "actionHook": "object|string", "answerOnBridge": "boolean", "callerId": "string", "confirmHook": "object|string", "referHook": "object|string", "dialMusic": "string", "dtmfCapture": "object", "dtmfHook": "object|string", "headers": "object", "listen": "#listen", "target": ["#target"], "timeLimit": "number", "timeout": "number", "proxy": "string", "transcribe": "#transcribe", "amd": "#amd" }, "required": [ "target" ] }, "dialogflow": { "properties": { "id": "string", "credentials": "object|string", "project": "string", "environment": "string", "region": { "type": "string", "enum": ["europe-west1", "europe-west2", "australia-southeast1", "asia-northeast1"] }, "lang": "string", "actionHook": "object|string", "eventHook": "object|string", "events": "[string]", "welcomeEvent": "string", "welcomeEventParams": "object", "noInputTimeout": "number", "noInputEvent": "string", "passDtmfAsTextInput": "boolean", "thinkingMusic": "string", "tts": "#synthesizer", "bargein": "boolean" }, "required": [ "project", "credentials", "lang" ] }, "dtmf": { "properties": { "id": "string", "dtmf": "string", "duration": "number" }, "required": [ "dtmf" ] }, "lex": { "properties": { "id": "string", "botId": "string", "botAlias": "string", "credentials": "object", "region": "string", "locale": "string", "intent": "#lexIntent", "welcomeMessage": "string", "metadata": "object", "bargein": "boolean", "passDtmf": "boolean", "actionHook": "object|string", "eventHook": "object|string", "noInputTimeout": "number", "tts": "#synthesizer" }, "required": [ "botId", "botAlias", "region", "credentials" ] }, "listen": { "properties": { "id": "string", "actionHook": "object|string", "auth": "#auth", "finishOnKey": "string", "maxLength": "number", "metadata": "object", "mixType": { "type": "string", "enum": ["mono", "stereo", "mixed"] }, "passDtmf": "boolean", "playBeep": "boolean", "sampleRate": "number", "timeout": "number", "transcribe": "#transcribe", "url": "string", "wsAuth": "#auth", "earlyMedia": "boolean" }, "required": [ "url" ] }, "message": { "properties": { "id": "string", "carrier": "string", "account_sid": "string", "message_sid": "string", "to": "string", "from": "string", "text": "string", "media": "string|array", "actionHook": "object|string" }, "required": [ "to", "from" ] }, "pause": { "properties": { "id": "string", "length": "number" }, "required": [ "length" ] }, "rasa": { "properties": { "id": "string", "url": "string", "recognizer": "#recognizer", "tts": "#synthesizer", "prompt": "string", "actionHook": "object|string", "eventHook": "object|string" }, "required": [ "url" ] }, "record": { "properties": { "path": "string" }, "required": [ "path" ] }, "recordOptions": { "properties": { "action": { "type": "string", "enum": ["startCallRecording", "stopCallRecording", "pauseCallRecording", "resumeCallRecording"] }, "recordingID": "string", "siprecServerURL": "string" }, "required": [ "action" ] }, "redirect": { "properties": { "id": "string", "actionHook": "object|string" }, "required": [ "actionHook" ] }, "rest:dial": { "properties": { "id": "string", "account_sid": "string", "application_sid": "string", "call_hook": "object|string", "call_status_hook": "object|string", "from": "string", "fromHost": "string", "speech_synthesis_vendor": "string", "speech_synthesis_voice": "string", "speech_synthesis_language": "string", "speech_recognizer_vendor": "string", "speech_recognizer_language": "string", "tag": "object", "to": "#target", "headers": "object", "timeout": "number" }, "required": [ "call_hook", "from", "to" ] }, "tag": { "properties": { "id": "string", "data": "object" }, "required": [ "data" ] }, "transcribe": { "properties": { "id": "string", "transcriptionHook": "string", "recognizer": "#recognizer", "earlyMedia": "boolean" }, "required": [ "recognizer" ] }, "target": { "properties": { "type": { "type": "string", "enum": ["phone", "sip", "user", "teams"] }, "confirmHook": "object|string", "method": { "type": "string", "enum": ["GET", "POST"] }, "headers": "object", "from": "#dialFrom", "name": "string", "number": "string", "sipUri": "string", "auth": "#auth", "vmail": "boolean", "tenant": "string", "trunk": "string", "overrideTo": "string" }, "required": [ "type" ] }, "dialFrom": { "properties": { "user": "string", "host": "string" }, "required": [ ] }, "auth": { "properties": { "username": "string", "password": "string" }, "required": [ "username", "password" ] }, "synthesizer": { "properties": { "vendor": { "type": "string", "enum": ["google", "aws", "polly", "microsoft", "nuance", "ibm", "default"] }, "language": "string", "voice": "string", "engine": { "type": "string", "enum": ["standard", "neural"] }, "gender": { "type": "string", "enum": ["MALE", "FEMALE", "NEUTRAL"] } }, "required": [ "vendor" ] }, "recognizer": { "properties": { "vendor": { "type": "string", "enum": ["google", "aws", "microsoft", "nuance", "deepgram", "ibm", "default"] }, "language": "string", "vad": "#vad", "hints": "array", "hintsBoost": "number", "altLanguages": "array", "profanityFilter": "boolean", "interim": "boolean", "singleUtterance": "boolean", "dualChannel": "boolean", "separateRecognitionPerChannel": "boolean", "punctuation": "boolean", "enhancedModel": "boolean", "words": "boolean", "diarization": "boolean", "diarizationMinSpeakers": "number", "diarizationMaxSpeakers": "number", "interactionType": { "type": "string", "enum": [ "unspecified", "discussion", "presentation", "phone_call", "voicemail", "voice_search", "voice_command", "dictation" ] }, "naicsCode": "number", "identifyChannels": "boolean", "vocabularyName": "string", "vocabularyFilterName": "string", "filterMethod": { "type": "string", "enum": [ "remove", "mask", "tag" ] }, "model": "string", "outputFormat": { "type": "string", "enum": [ "simple", "detailed" ] }, "profanityOption": { "type": "string", "enum": [ "masked", "removed", "raw" ] }, "requestSnr": "boolean", "initialSpeechTimeoutMs": "number", "azureServiceEndpoint": "string", "azureSttEndpointId": "string", "asrDtmfTerminationDigit": "string", "asrTimeout": "number", "nuanceOptions": "#nuanceOptions", "deepgramOptions": "#deepgramOptions", "ibmOptions": "#ibmOptions" }, "required": [ "vendor" ] }, "ibmOptions": { "properties": { "sttApiKey": "string", "sttRegion": "string", "ttsApiKey": "string", "ttsRegion": "string", "instanceId": "string", "model": "string", "languageCustomizationId": "string", "acousticCustomizationId": "string", "baseModelVersion": "string", "watsonMetadata": "string", "watsonLearningOptOut": "boolean" }, "required": [ ] }, "deepgramOptions": { "properties": { "apiKey": "string", "tier": { "type": "string", "enum": [ "enhanced", "base" ] }, "model": { "type": "string", "enum": [ "general", "meeting", "phonecall", "voicemail", "finance", "conversationalai", "video", "custom" ] }, "customModel": "string", "version": "string", "punctuate": "boolean", "profanityFilter": "boolean", "redact": { "type": "string", "enum": [ "pci", "numbers", "true", "ssn" ] }, "diarize": "boolean", "diarizeVersion": "string", "ner": "boolean", "multichannel": "boolean", "alternatives": "number", "numerals": "boolean", "search": "array", "replace": "array", "keywords": "array", "endpointing": "boolean", "vadTurnoff": "number", "tag": "string" } }, "nuanceOptions": { "properties": { "clientId": "string", "secret": "string", "kryptonEndpoint": "string", "topic": "string", "utteranceDetectionMode": { "type": "string", "enum": [ "single", "multiple", "disabled" ] }, "punctuation": "boolean", "profanityFilter": "boolean", "includeTokenization": "boolean", "discardSpeakerAdaptation": "boolean", "suppressCallRecording": "boolean", "maskLoadFailures": "boolean", "suppressInitialCapitalization": "boolean", "allowZeroBaseLmWeight": "boolean", "filterWakeupWord": "boolean", "resultType": { "type": "string", "enum": [ "final", "partial", "immutable_partial" ] }, "noInputTimeoutMs": "number", "recognitionTimeoutMs": "number", "utteranceEndSilenceMs": "number", "maxHypotheses": "number", "speechDomain": "string", "formatting": "#formatting", "clientData": "object", "userId": "string", "speechDetectionSensitivity": "number", "resources": ["#resource"] }, "required": [ ] }, "resource": { "properties": { "externalReference": "#resourceReference", "inlineWordset": "string", "builtin": "string", "inlineGrammar": "string", "wakeupWord": "[string]", "weightName": { "type": "string", "enum": [ "defaultWeight", "lowest", "low", "medium", "high", "highest" ] }, "weightValue": "number", "reuse": { "type": "string", "enum": [ "undefined_reuse", "low_reuse", "high_reuse" ] } }, "required": [ ] }, "resourceReference": { "properties": { "type": { "type": "string", "enum": [ "undefined_resource_type", "wordset", "compiled_wordset", "domain_lm", "speaker_profile", "grammar", "settings" ] }, "uri": "string", "maxLoadFailures": "boolean", "requestTimeoutMs": "number", "headers": "object" }, "required": [ ] }, "formatting": { "properties": { "scheme": "string", "options": "object" }, "required": [ "scheme", "options" ] }, "lexIntent": { "properties": { "name": "string", "slots": "object" }, "required": [ "name" ] }, "vad": { "properties": { "enable": "boolean", "voiceMs": "number", "mode": "number" }, "required": [ "enable" ] }, "amd": { "properties": { "actionHook": "object|string", "thresholdWordCount": "number", "timers": "#amdTimers", "recognizer": "#recognizer" }, "required": [ "actionHook" ] }, "amdTimers": { "properties": { "noSpeechTimeoutMs": "number", "decisionTimeoutMs": "number", "toneTimeoutMs": "number", "greetingCompletionTimeoutMs": "number" } } }