@jambonz/sdk 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/schema/callbacks/amd.schema.json +50 -0
- package/schema/components/amd.schema.json +1 -1
- package/schema/verbs/alert.schema.json +19 -5
- package/schema/verbs/answer.schema.json +13 -3
- package/schema/verbs/conference.schema.json +85 -21
- package/schema/verbs/config.schema.json +62 -18
- package/schema/verbs/deepgram_s2s.schema.json +64 -5
- package/schema/verbs/dequeue.schema.json +20 -5
- package/schema/verbs/dial.schema.json +48 -14
- package/schema/verbs/dialogflow.schema.json +37 -9
- package/schema/verbs/dtmf.schema.json +29 -7
- package/schema/verbs/dub.schema.json +65 -14
- package/schema/verbs/elevenlabs_s2s.schema.json +24 -6
- package/schema/verbs/enqueue.schema.json +20 -5
- package/schema/verbs/gather.schema.json +55 -12
- package/schema/verbs/google_s2s.schema.json +24 -5
- package/schema/verbs/hangup.schema.json +10 -3
- package/schema/verbs/leave.schema.json +13 -3
- package/schema/verbs/listen.schema.json +24 -6
- package/schema/verbs/llm.schema.json +17 -4
- package/schema/verbs/message.schema.json +66 -14
- package/schema/verbs/openai_s2s.schema.json +24 -5
- package/schema/verbs/pause.schema.json +13 -3
- package/schema/verbs/pipeline.schema.json +61 -14
- package/schema/verbs/play.schema.json +38 -11
- package/schema/verbs/redirect.schema.json +15 -4
- package/schema/verbs/s2s.schema.json +16 -3
- package/schema/verbs/say.schema.json +31 -8
- package/schema/verbs/sip-decline.schema.json +35 -8
- package/schema/verbs/sip-refer.schema.json +23 -6
- package/schema/verbs/sip-request.schema.json +27 -6
- package/schema/verbs/stream.schema.json +92 -20
- package/schema/verbs/tag.schema.json +25 -5
- package/schema/verbs/transcribe.schema.json +12 -3
- package/schema/verbs/ultravox_s2s.schema.json +24 -5
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/dialogflow",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Dialogflow",
|
|
5
6
|
"description": "Connects the caller to a Google Dialogflow agent for a voice conversation. Supports Dialogflow ES, CX, and CES models. The caller speaks and Dialogflow handles intent detection and response generation.",
|
|
6
7
|
"type": "object",
|
|
@@ -15,8 +16,13 @@
|
|
|
15
16
|
},
|
|
16
17
|
"credentials": {
|
|
17
18
|
"oneOf": [
|
|
18
|
-
{
|
|
19
|
-
|
|
19
|
+
{
|
|
20
|
+
"type": "object",
|
|
21
|
+
"additionalProperties": true
|
|
22
|
+
},
|
|
23
|
+
{
|
|
24
|
+
"type": "string"
|
|
25
|
+
}
|
|
20
26
|
],
|
|
21
27
|
"description": "Google service account credentials as a JSON object or stringified JSON."
|
|
22
28
|
},
|
|
@@ -38,7 +44,11 @@
|
|
|
38
44
|
},
|
|
39
45
|
"model": {
|
|
40
46
|
"type": "string",
|
|
41
|
-
"enum": [
|
|
47
|
+
"enum": [
|
|
48
|
+
"es",
|
|
49
|
+
"cx",
|
|
50
|
+
"ces"
|
|
51
|
+
],
|
|
42
52
|
"description": "The Dialogflow model type: 'es' for Dialogflow ES, 'cx' for Dialogflow CX, 'ces' for Dialogflow CES."
|
|
43
53
|
},
|
|
44
54
|
"lang": {
|
|
@@ -55,7 +65,9 @@
|
|
|
55
65
|
},
|
|
56
66
|
"events": {
|
|
57
67
|
"type": "array",
|
|
58
|
-
"items": {
|
|
68
|
+
"items": {
|
|
69
|
+
"type": "string"
|
|
70
|
+
},
|
|
59
71
|
"description": "List of event types to receive via the eventHook."
|
|
60
72
|
},
|
|
61
73
|
"welcomeEvent": {
|
|
@@ -95,15 +107,31 @@
|
|
|
95
107
|
"type": "object",
|
|
96
108
|
"description": "Initial query input to send to Dialogflow.",
|
|
97
109
|
"properties": {
|
|
98
|
-
"text": {
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
110
|
+
"text": {
|
|
111
|
+
"type": "string",
|
|
112
|
+
"description": "Text input."
|
|
113
|
+
},
|
|
114
|
+
"intent": {
|
|
115
|
+
"type": "string",
|
|
116
|
+
"description": "Intent to trigger."
|
|
117
|
+
},
|
|
118
|
+
"event": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"description": "Event to trigger."
|
|
121
|
+
},
|
|
122
|
+
"dtmf": {
|
|
123
|
+
"type": "string",
|
|
124
|
+
"description": "DTMF input."
|
|
125
|
+
}
|
|
102
126
|
},
|
|
103
127
|
"additionalProperties": false
|
|
104
128
|
}
|
|
105
129
|
},
|
|
106
|
-
"required": [
|
|
130
|
+
"required": [
|
|
131
|
+
"project",
|
|
132
|
+
"credentials",
|
|
133
|
+
"lang"
|
|
134
|
+
],
|
|
107
135
|
"examples": [
|
|
108
136
|
{
|
|
109
137
|
"verb": "dialogflow",
|
|
@@ -1,27 +1,49 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/dtmf",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "DTMF",
|
|
5
6
|
"description": "Sends DTMF tones on the call. Used to interact with IVR systems on the far end, or to signal systems that respond to DTMF.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "dtmf"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"dtmf": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The DTMF digits to send. Valid characters are 0-9, *, #, and A-D. Use 'w' for a 500ms pause between digits.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"1234#",
|
|
21
|
+
"1w2w3",
|
|
22
|
+
"5551212"
|
|
23
|
+
]
|
|
14
24
|
},
|
|
15
25
|
"duration": {
|
|
16
26
|
"type": "number",
|
|
17
27
|
"description": "Duration in milliseconds for each DTMF tone.",
|
|
18
28
|
"default": 500,
|
|
19
|
-
"examples": [
|
|
29
|
+
"examples": [
|
|
30
|
+
250,
|
|
31
|
+
500
|
|
32
|
+
]
|
|
20
33
|
}
|
|
21
34
|
},
|
|
22
|
-
"required": [
|
|
35
|
+
"required": [
|
|
36
|
+
"dtmf"
|
|
37
|
+
],
|
|
23
38
|
"examples": [
|
|
24
|
-
{
|
|
25
|
-
|
|
39
|
+
{
|
|
40
|
+
"verb": "dtmf",
|
|
41
|
+
"dtmf": "1234#"
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
"verb": "dtmf",
|
|
45
|
+
"dtmf": "1w2w3w4",
|
|
46
|
+
"duration": 250
|
|
47
|
+
}
|
|
26
48
|
]
|
|
27
49
|
}
|
|
@@ -1,21 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/dub",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Dub",
|
|
5
6
|
"description": "Manages audio dubbing tracks on a call. Allows adding, removing, and controlling auxiliary audio tracks that are mixed into the call audio. Used for background music, coaching whispers, or injecting audio from external sources.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "dub"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"action": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The dubbing action to perform.",
|
|
13
|
-
"enum": [
|
|
19
|
+
"enum": [
|
|
20
|
+
"addTrack",
|
|
21
|
+
"removeTrack",
|
|
22
|
+
"silenceTrack",
|
|
23
|
+
"playOnTrack",
|
|
24
|
+
"sayOnTrack"
|
|
25
|
+
]
|
|
14
26
|
},
|
|
15
27
|
"track": {
|
|
16
28
|
"type": "string",
|
|
17
29
|
"description": "The name of the audio track. Used to reference the track in subsequent dub actions.",
|
|
18
|
-
"examples": [
|
|
30
|
+
"examples": [
|
|
31
|
+
"background-music",
|
|
32
|
+
"coach-whisper"
|
|
33
|
+
]
|
|
19
34
|
},
|
|
20
35
|
"play": {
|
|
21
36
|
"type": "string",
|
|
@@ -24,8 +39,13 @@
|
|
|
24
39
|
},
|
|
25
40
|
"say": {
|
|
26
41
|
"oneOf": [
|
|
27
|
-
{
|
|
28
|
-
|
|
42
|
+
{
|
|
43
|
+
"type": "string"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"type": "object",
|
|
47
|
+
"additionalProperties": true
|
|
48
|
+
}
|
|
29
49
|
],
|
|
30
50
|
"description": "Text to synthesize and play on the track. Used with 'sayOnTrack' action. Can be a string or a say configuration object."
|
|
31
51
|
},
|
|
@@ -35,18 +55,49 @@
|
|
|
35
55
|
},
|
|
36
56
|
"gain": {
|
|
37
57
|
"oneOf": [
|
|
38
|
-
{
|
|
39
|
-
|
|
58
|
+
{
|
|
59
|
+
"type": "number"
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"type": "string"
|
|
63
|
+
}
|
|
40
64
|
],
|
|
41
65
|
"description": "Audio gain for the track in dB. Use negative values to reduce volume.",
|
|
42
|
-
"examples": [
|
|
66
|
+
"examples": [
|
|
67
|
+
-10,
|
|
68
|
+
0,
|
|
69
|
+
6
|
|
70
|
+
]
|
|
43
71
|
}
|
|
44
72
|
},
|
|
45
|
-
"required": [
|
|
73
|
+
"required": [
|
|
74
|
+
"action",
|
|
75
|
+
"track"
|
|
76
|
+
],
|
|
46
77
|
"examples": [
|
|
47
|
-
{
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
78
|
+
{
|
|
79
|
+
"verb": "dub",
|
|
80
|
+
"action": "addTrack",
|
|
81
|
+
"track": "bgm"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"verb": "dub",
|
|
85
|
+
"action": "playOnTrack",
|
|
86
|
+
"track": "bgm",
|
|
87
|
+
"play": "https://example.com/music.mp3",
|
|
88
|
+
"loop": true,
|
|
89
|
+
"gain": -15
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"verb": "dub",
|
|
93
|
+
"action": "sayOnTrack",
|
|
94
|
+
"track": "coach",
|
|
95
|
+
"say": "Ask about their budget"
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"verb": "dub",
|
|
99
|
+
"action": "removeTrack",
|
|
100
|
+
"track": "bgm"
|
|
101
|
+
}
|
|
51
102
|
]
|
|
52
103
|
}
|
|
@@ -1,13 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/elevenlabs_s2s",
|
|
4
|
+
"minVersion": "10.1.0",
|
|
4
5
|
"title": "ElevenLabs S2S",
|
|
5
6
|
"description": "Shortcut for 'llm' with vendor automatically set to 'elevenlabs'. Connects the caller to an ElevenLabs Conversational AI agent for real-time speech-to-speech voice conversation. Unlike other s2s vendors, ElevenLabs requires a pre-configured agent_id rather than a model and messages.",
|
|
6
7
|
"type": "object",
|
|
7
|
-
"allOf": [
|
|
8
|
+
"allOf": [
|
|
9
|
+
{
|
|
10
|
+
"$ref": "../components/llm-base"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
8
13
|
"properties": {
|
|
9
|
-
"verb": {
|
|
10
|
-
|
|
14
|
+
"verb": {
|
|
15
|
+
"const": "elevenlabs_s2s",
|
|
16
|
+
"description": "The verb name."
|
|
17
|
+
},
|
|
18
|
+
"vendor": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"const": "elevenlabs",
|
|
21
|
+
"description": "The LLM vendor (always 'elevenlabs' for this shortcut)."
|
|
22
|
+
},
|
|
11
23
|
"auth": {
|
|
12
24
|
"type": "object",
|
|
13
25
|
"description": "Authentication credentials for ElevenLabs. Requires agent_id; api_key is optional (if not provided, an unsigned URL is used).",
|
|
@@ -21,7 +33,9 @@
|
|
|
21
33
|
"description": "The ElevenLabs API key. Optional; when provided, a signed URL is used for the WebSocket connection."
|
|
22
34
|
}
|
|
23
35
|
},
|
|
24
|
-
"required": [
|
|
36
|
+
"required": [
|
|
37
|
+
"agent_id"
|
|
38
|
+
]
|
|
25
39
|
},
|
|
26
40
|
"llmOptions": {
|
|
27
41
|
"type": "object",
|
|
@@ -46,7 +60,9 @@
|
|
|
46
60
|
"additionalProperties": true
|
|
47
61
|
}
|
|
48
62
|
},
|
|
49
|
-
"required": [
|
|
63
|
+
"required": [
|
|
64
|
+
"auth"
|
|
65
|
+
],
|
|
50
66
|
"examples": [
|
|
51
67
|
{
|
|
52
68
|
"verb": "elevenlabs_s2s",
|
|
@@ -57,7 +73,9 @@
|
|
|
57
73
|
"llmOptions": {},
|
|
58
74
|
"actionHook": "/s2s-complete",
|
|
59
75
|
"eventHook": "/event",
|
|
60
|
-
"events": [
|
|
76
|
+
"events": [
|
|
77
|
+
"all"
|
|
78
|
+
]
|
|
61
79
|
}
|
|
62
80
|
]
|
|
63
81
|
}
|
|
@@ -1,16 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/enqueue",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Enqueue",
|
|
5
6
|
"description": "Places the caller into a named call queue. While in the queue, the caller hears content returned by the waitHook (typically hold music or position announcements). The caller remains in the queue until dequeued by another call or process.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "enqueue"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"name": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The name of the queue to place the caller in. Queues are created implicitly when first referenced.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"support",
|
|
21
|
+
"sales"
|
|
22
|
+
]
|
|
14
23
|
},
|
|
15
24
|
"actionHook": {
|
|
16
25
|
"$ref": "../components/actionHook",
|
|
@@ -23,10 +32,16 @@
|
|
|
23
32
|
"priority": {
|
|
24
33
|
"type": "number",
|
|
25
34
|
"description": "The priority of this caller in the queue. Lower numbers are higher priority and are dequeued first.",
|
|
26
|
-
"examples": [
|
|
35
|
+
"examples": [
|
|
36
|
+
1,
|
|
37
|
+
5,
|
|
38
|
+
10
|
|
39
|
+
]
|
|
27
40
|
}
|
|
28
41
|
},
|
|
29
|
-
"required": [
|
|
42
|
+
"required": [
|
|
43
|
+
"name"
|
|
44
|
+
],
|
|
30
45
|
"examples": [
|
|
31
46
|
{
|
|
32
47
|
"verb": "enqueue",
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/gather",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Gather",
|
|
5
6
|
"description": "Collects user input via speech (STT) and/or DTMF digits. Optionally plays a prompt (using nested 'say' or 'play') while listening. When input is received, the result is sent to the actionHook which should return the next set of verbs. This is the primary verb for building interactive voice menus and conversational flows.",
|
|
6
7
|
"type": "object",
|
|
@@ -21,16 +22,35 @@
|
|
|
21
22
|
"type": "array",
|
|
22
23
|
"items": {
|
|
23
24
|
"type": "string",
|
|
24
|
-
"enum": [
|
|
25
|
+
"enum": [
|
|
26
|
+
"speech",
|
|
27
|
+
"digits"
|
|
28
|
+
]
|
|
25
29
|
},
|
|
26
30
|
"description": "The types of input to accept. Can include 'speech' (STT), 'digits' (DTMF), or both.",
|
|
27
|
-
"default": [
|
|
28
|
-
|
|
31
|
+
"default": [
|
|
32
|
+
"digits"
|
|
33
|
+
],
|
|
34
|
+
"examples": [
|
|
35
|
+
[
|
|
36
|
+
"speech",
|
|
37
|
+
"digits"
|
|
38
|
+
],
|
|
39
|
+
[
|
|
40
|
+
"speech"
|
|
41
|
+
],
|
|
42
|
+
[
|
|
43
|
+
"digits"
|
|
44
|
+
]
|
|
45
|
+
]
|
|
29
46
|
},
|
|
30
47
|
"finishOnKey": {
|
|
31
48
|
"type": "string",
|
|
32
49
|
"description": "A DTMF key that signals the end of digit input. The key itself is not included in the collected digits.",
|
|
33
|
-
"examples": [
|
|
50
|
+
"examples": [
|
|
51
|
+
"#",
|
|
52
|
+
"*"
|
|
53
|
+
]
|
|
34
54
|
},
|
|
35
55
|
"numDigits": {
|
|
36
56
|
"type": "number",
|
|
@@ -47,17 +67,25 @@
|
|
|
47
67
|
"interDigitTimeout": {
|
|
48
68
|
"type": "number",
|
|
49
69
|
"description": "Time in seconds to wait between DTMF digits before considering input complete.",
|
|
50
|
-
"examples": [
|
|
70
|
+
"examples": [
|
|
71
|
+
5
|
|
72
|
+
]
|
|
51
73
|
},
|
|
52
74
|
"speechTimeout": {
|
|
53
75
|
"type": "number",
|
|
54
76
|
"description": "Time in seconds of silence after speech before considering the utterance complete.",
|
|
55
|
-
"examples": [
|
|
77
|
+
"examples": [
|
|
78
|
+
2,
|
|
79
|
+
3
|
|
80
|
+
]
|
|
56
81
|
},
|
|
57
82
|
"timeout": {
|
|
58
83
|
"type": "number",
|
|
59
84
|
"description": "Overall timeout in seconds. If no input is received within this time, the gather completes with no input and the actionHook is invoked.",
|
|
60
|
-
"examples": [
|
|
85
|
+
"examples": [
|
|
86
|
+
10,
|
|
87
|
+
30
|
|
88
|
+
]
|
|
61
89
|
},
|
|
62
90
|
"partialResultHook": {
|
|
63
91
|
"$ref": "../components/actionHook",
|
|
@@ -79,7 +107,10 @@
|
|
|
79
107
|
"minBargeinWordCount": {
|
|
80
108
|
"type": "number",
|
|
81
109
|
"description": "Minimum number of words that must be recognized before barge-in is triggered. Prevents brief noises from interrupting prompts.",
|
|
82
|
-
"examples": [
|
|
110
|
+
"examples": [
|
|
111
|
+
1,
|
|
112
|
+
2
|
|
113
|
+
]
|
|
83
114
|
},
|
|
84
115
|
"recognizer": {
|
|
85
116
|
"$ref": "../components/recognizer",
|
|
@@ -105,7 +136,10 @@
|
|
|
105
136
|
"examples": [
|
|
106
137
|
{
|
|
107
138
|
"verb": "gather",
|
|
108
|
-
"input": [
|
|
139
|
+
"input": [
|
|
140
|
+
"speech",
|
|
141
|
+
"digits"
|
|
142
|
+
],
|
|
109
143
|
"actionHook": "/gather-result",
|
|
110
144
|
"timeout": 15,
|
|
111
145
|
"say": {
|
|
@@ -114,7 +148,9 @@
|
|
|
114
148
|
},
|
|
115
149
|
{
|
|
116
150
|
"verb": "gather",
|
|
117
|
-
"input": [
|
|
151
|
+
"input": [
|
|
152
|
+
"digits"
|
|
153
|
+
],
|
|
118
154
|
"actionHook": "/menu-selection",
|
|
119
155
|
"numDigits": 1,
|
|
120
156
|
"say": {
|
|
@@ -123,14 +159,21 @@
|
|
|
123
159
|
},
|
|
124
160
|
{
|
|
125
161
|
"verb": "gather",
|
|
126
|
-
"input": [
|
|
162
|
+
"input": [
|
|
163
|
+
"speech"
|
|
164
|
+
],
|
|
127
165
|
"actionHook": "/process-speech",
|
|
128
166
|
"timeout": 20,
|
|
129
167
|
"bargein": true,
|
|
130
168
|
"recognizer": {
|
|
131
169
|
"vendor": "deepgram",
|
|
132
170
|
"language": "en-US",
|
|
133
|
-
"hints": [
|
|
171
|
+
"hints": [
|
|
172
|
+
"account",
|
|
173
|
+
"balance",
|
|
174
|
+
"transfer",
|
|
175
|
+
"payment"
|
|
176
|
+
]
|
|
134
177
|
},
|
|
135
178
|
"say": {
|
|
136
179
|
"text": "How can I help you today?"
|
|
@@ -1,21 +1,40 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/google_s2s",
|
|
4
|
+
"minVersion": "10.1.0",
|
|
4
5
|
"title": "Google S2S",
|
|
5
6
|
"description": "Shortcut for 'llm' with vendor automatically set to 'google'. Connects the caller to a Google model for real-time speech-to-speech voice conversation.",
|
|
6
7
|
"type": "object",
|
|
7
|
-
"allOf": [
|
|
8
|
+
"allOf": [
|
|
9
|
+
{
|
|
10
|
+
"$ref": "../components/llm-base"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
8
13
|
"properties": {
|
|
9
|
-
"verb": {
|
|
10
|
-
|
|
14
|
+
"verb": {
|
|
15
|
+
"const": "google_s2s",
|
|
16
|
+
"description": "The verb name."
|
|
17
|
+
},
|
|
18
|
+
"vendor": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"const": "google",
|
|
21
|
+
"description": "The LLM vendor (always 'google' for this shortcut)."
|
|
22
|
+
}
|
|
11
23
|
},
|
|
12
|
-
"required": [
|
|
24
|
+
"required": [
|
|
25
|
+
"llmOptions"
|
|
26
|
+
],
|
|
13
27
|
"examples": [
|
|
14
28
|
{
|
|
15
29
|
"verb": "google_s2s",
|
|
16
30
|
"model": "gemini-2.0-flash",
|
|
17
31
|
"llmOptions": {
|
|
18
|
-
"messages": [
|
|
32
|
+
"messages": [
|
|
33
|
+
{
|
|
34
|
+
"role": "system",
|
|
35
|
+
"content": "You are a helpful voice assistant."
|
|
36
|
+
}
|
|
37
|
+
]
|
|
19
38
|
},
|
|
20
39
|
"actionHook": "/s2s-complete"
|
|
21
40
|
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/hangup",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Hangup",
|
|
5
6
|
"description": "Terminates the call. Optionally includes custom SIP headers on the BYE request.",
|
|
6
7
|
"type": "object",
|
|
@@ -16,14 +17,20 @@
|
|
|
16
17
|
"headers": {
|
|
17
18
|
"type": "object",
|
|
18
19
|
"description": "Custom SIP headers to include on the BYE request.",
|
|
19
|
-
"additionalProperties": {
|
|
20
|
+
"additionalProperties": {
|
|
21
|
+
"type": "string"
|
|
22
|
+
}
|
|
20
23
|
}
|
|
21
24
|
},
|
|
22
25
|
"examples": [
|
|
23
|
-
{
|
|
26
|
+
{
|
|
27
|
+
"verb": "hangup"
|
|
28
|
+
},
|
|
24
29
|
{
|
|
25
30
|
"verb": "hangup",
|
|
26
|
-
"headers": {
|
|
31
|
+
"headers": {
|
|
32
|
+
"X-Reason": "call-complete"
|
|
33
|
+
}
|
|
27
34
|
}
|
|
28
35
|
]
|
|
29
36
|
}
|
|
@@ -1,12 +1,22 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/leave",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Leave",
|
|
5
6
|
"description": "Removes the caller from a conference or queue that they are currently in. Execution continues with the next verb in the application.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "leave"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
}
|
|
10
16
|
},
|
|
11
|
-
"examples": [
|
|
17
|
+
"examples": [
|
|
18
|
+
{
|
|
19
|
+
"verb": "leave"
|
|
20
|
+
}
|
|
21
|
+
]
|
|
12
22
|
}
|