@jambonz/sdk 0.1.7 → 0.1.13
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/dist/client/index.d.cts +2 -2
- package/dist/client/index.d.ts +2 -2
- package/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/{rest-Ct1hlTMi.d.ts → rest-DEEB3QK9.d.ts} +1 -1
- package/dist/{rest-CtGvvaaV.d.cts → rest-Q_HBbPz4.d.cts} +1 -1
- package/dist/types/index.d.cts +2 -2
- package/dist/types/index.d.ts +2 -2
- package/dist/{verb-builder-BJalSF8p.d.cts → verb-builder-CciZHUjo.d.cts} +1 -1
- package/dist/{verb-builder-CclNap8d.d.ts → verb-builder-CmrtErY7.d.ts} +1 -1
- package/dist/{verbs-boTMgOLb.d.cts → verbs-B_lYU2RS.d.cts} +2 -0
- package/dist/{verbs-boTMgOLb.d.ts → verbs-B_lYU2RS.d.ts} +2 -0
- package/dist/webhook/index.d.cts +2 -2
- package/dist/webhook/index.d.ts +2 -2
- package/dist/websocket/index.cjs +2 -2
- package/dist/websocket/index.cjs.map +1 -1
- package/dist/websocket/index.d.cts +2 -2
- package/dist/websocket/index.d.ts +2 -2
- package/dist/websocket/index.js +2 -2
- package/dist/websocket/index.js.map +1 -1
- package/package.json +1 -1
- package/schema/callbacks/amd.schema.json +50 -0
- package/schema/components/amd.schema.json +1 -1
- package/schema/components/recognizer-assemblyAiOptions.schema.json +32 -1
- package/schema/components/recognizer-awsOptions.schema.json +1 -1
- package/schema/components/recognizer-azureOptions.schema.json +1 -1
- package/schema/components/recognizer-cobaltOptions.schema.json +1 -1
- package/schema/components/recognizer-customOptions.schema.json +1 -1
- package/schema/components/recognizer-deepgramOptions.schema.json +1 -1
- package/schema/components/recognizer-elevenlabsOptions.schema.json +1 -1
- package/schema/components/recognizer-gladiaOptions.schema.json +1 -1
- package/schema/components/recognizer-googleOptions.schema.json +1 -1
- package/schema/components/recognizer-houndifyOptions.schema.json +1 -1
- package/schema/components/recognizer-ibmOptions.schema.json +1 -1
- package/schema/components/recognizer-nuanceOptions.schema.json +1 -1
- package/schema/components/recognizer-nvidiaOptions.schema.json +1 -1
- package/schema/components/recognizer-openaiOptions.schema.json +1 -1
- package/schema/components/recognizer-sonioxOptions.schema.json +1 -1
- package/schema/components/recognizer-speechmaticsOptions.schema.json +1 -1
- package/schema/components/recognizer-verbioOptions.schema.json +1 -1
- package/schema/components/recognizer.schema.json +4 -0
- 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,24 +1,37 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/s2s",
|
|
4
|
+
"minVersion": "10.1.0",
|
|
4
5
|
"title": "S2S",
|
|
5
6
|
"description": "Synonym for 'llm'. Connects the caller to a large language model for a real-time speech-to-speech voice conversation. Requires 'vendor' to be specified explicitly.",
|
|
6
7
|
"type": "object",
|
|
7
|
-
"allOf": [
|
|
8
|
+
"allOf": [
|
|
9
|
+
{
|
|
10
|
+
"$ref": "../components/llm-base"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
8
13
|
"properties": {
|
|
9
14
|
"verb": {
|
|
10
15
|
"const": "s2s",
|
|
11
16
|
"description": "The verb name."
|
|
12
17
|
}
|
|
13
18
|
},
|
|
14
|
-
"required": [
|
|
19
|
+
"required": [
|
|
20
|
+
"vendor",
|
|
21
|
+
"llmOptions"
|
|
22
|
+
],
|
|
15
23
|
"examples": [
|
|
16
24
|
{
|
|
17
25
|
"verb": "s2s",
|
|
18
26
|
"vendor": "openai",
|
|
19
27
|
"model": "gpt-4o-realtime",
|
|
20
28
|
"llmOptions": {
|
|
21
|
-
"messages": [
|
|
29
|
+
"messages": [
|
|
30
|
+
{
|
|
31
|
+
"role": "system",
|
|
32
|
+
"content": "You are a helpful voice assistant."
|
|
33
|
+
}
|
|
34
|
+
]
|
|
22
35
|
},
|
|
23
36
|
"actionHook": "/s2s-complete"
|
|
24
37
|
}
|
|
@@ -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/say",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Say",
|
|
5
6
|
"description": "Speaks text to the caller using text-to-speech. The text can be plain text or SSML. Optionally streams TTS output incrementally for lower latency. This is one of the most commonly used verbs in jambonz applications.",
|
|
6
7
|
"type": "object",
|
|
@@ -15,23 +16,34 @@
|
|
|
15
16
|
},
|
|
16
17
|
"text": {
|
|
17
18
|
"oneOf": [
|
|
18
|
-
{
|
|
19
|
+
{
|
|
20
|
+
"type": "string"
|
|
21
|
+
},
|
|
19
22
|
{
|
|
20
23
|
"type": "array",
|
|
21
|
-
"items": {
|
|
24
|
+
"items": {
|
|
25
|
+
"type": "string"
|
|
26
|
+
}
|
|
22
27
|
}
|
|
23
28
|
],
|
|
24
29
|
"description": "The text to speak. Can be plain text or SSML markup. If an array is provided, one entry is selected at random (useful for variety in prompts).",
|
|
25
30
|
"examples": [
|
|
26
31
|
"Hello, welcome to our service.",
|
|
27
32
|
"<speak>Hello <break time='500ms'/> welcome.</speak>",
|
|
28
|
-
[
|
|
33
|
+
[
|
|
34
|
+
"Hello!",
|
|
35
|
+
"Hi there!",
|
|
36
|
+
"Welcome!"
|
|
37
|
+
]
|
|
29
38
|
]
|
|
30
39
|
},
|
|
31
40
|
"instructions": {
|
|
32
41
|
"type": "string",
|
|
33
42
|
"description": "Natural language instructions to guide TTS expression and delivery. Supported by vendors that offer instruction-based synthesis (e.g. ElevenLabs, some OpenAI models).",
|
|
34
|
-
"examples": [
|
|
43
|
+
"examples": [
|
|
44
|
+
"Speak in a warm, friendly tone",
|
|
45
|
+
"Sound excited and energetic"
|
|
46
|
+
]
|
|
35
47
|
},
|
|
36
48
|
"stream": {
|
|
37
49
|
"type": "boolean",
|
|
@@ -39,11 +51,18 @@
|
|
|
39
51
|
},
|
|
40
52
|
"loop": {
|
|
41
53
|
"oneOf": [
|
|
42
|
-
{
|
|
43
|
-
|
|
54
|
+
{
|
|
55
|
+
"type": "number"
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"type": "string"
|
|
59
|
+
}
|
|
44
60
|
],
|
|
45
61
|
"description": "Number of times to repeat the speech. Use 0 or 'forever' to loop indefinitely until interrupted.",
|
|
46
|
-
"examples": [
|
|
62
|
+
"examples": [
|
|
63
|
+
2,
|
|
64
|
+
"forever"
|
|
65
|
+
]
|
|
47
66
|
},
|
|
48
67
|
"synthesizer": {
|
|
49
68
|
"$ref": "../components/synthesizer",
|
|
@@ -77,7 +96,11 @@
|
|
|
77
96
|
},
|
|
78
97
|
{
|
|
79
98
|
"verb": "say",
|
|
80
|
-
"text": [
|
|
99
|
+
"text": [
|
|
100
|
+
"Hello!",
|
|
101
|
+
"Hi there!",
|
|
102
|
+
"Welcome!"
|
|
103
|
+
],
|
|
81
104
|
"loop": 1
|
|
82
105
|
}
|
|
83
106
|
]
|
|
@@ -1,31 +1,58 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/sip:decline",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "SIP Decline",
|
|
5
6
|
"description": "Rejects an incoming call with a SIP error response. Used to decline calls with a specific status code and reason (e.g. 486 Busy Here, 603 Decline).",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "sip:decline"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"status": {
|
|
11
17
|
"type": "number",
|
|
12
18
|
"description": "The SIP response status code to send.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
486,
|
|
21
|
+
603,
|
|
22
|
+
404,
|
|
23
|
+
480
|
|
24
|
+
]
|
|
14
25
|
},
|
|
15
26
|
"reason": {
|
|
16
27
|
"type": "string",
|
|
17
28
|
"description": "The SIP reason phrase to include in the response.",
|
|
18
|
-
"examples": [
|
|
29
|
+
"examples": [
|
|
30
|
+
"Busy Here",
|
|
31
|
+
"Decline",
|
|
32
|
+
"Not Found"
|
|
33
|
+
]
|
|
19
34
|
},
|
|
20
35
|
"headers": {
|
|
21
36
|
"type": "object",
|
|
22
37
|
"description": "Custom SIP headers to include in the response.",
|
|
23
|
-
"additionalProperties": {
|
|
38
|
+
"additionalProperties": {
|
|
39
|
+
"type": "string"
|
|
40
|
+
}
|
|
24
41
|
}
|
|
25
42
|
},
|
|
26
|
-
"required": [
|
|
43
|
+
"required": [
|
|
44
|
+
"status"
|
|
45
|
+
],
|
|
27
46
|
"examples": [
|
|
28
|
-
{
|
|
29
|
-
|
|
47
|
+
{
|
|
48
|
+
"verb": "sip:decline",
|
|
49
|
+
"status": 486,
|
|
50
|
+
"reason": "Busy Here"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"verb": "sip:decline",
|
|
54
|
+
"status": 603,
|
|
55
|
+
"reason": "Decline"
|
|
56
|
+
}
|
|
30
57
|
]
|
|
31
58
|
}
|
|
@@ -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/sip:refer",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "SIP Refer",
|
|
5
6
|
"description": "Sends a SIP REFER request to transfer the call to another party. Initiates an attended or unattended (blind) transfer.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "sip:refer"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"referTo": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The SIP URI or phone number to transfer the call to.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"sip:alice@example.com",
|
|
21
|
+
"+15085551212"
|
|
22
|
+
]
|
|
14
23
|
},
|
|
15
24
|
"referredBy": {
|
|
16
25
|
"type": "string",
|
|
@@ -23,7 +32,9 @@
|
|
|
23
32
|
"headers": {
|
|
24
33
|
"type": "object",
|
|
25
34
|
"description": "Custom SIP headers to include in the REFER request.",
|
|
26
|
-
"additionalProperties": {
|
|
35
|
+
"additionalProperties": {
|
|
36
|
+
"type": "string"
|
|
37
|
+
}
|
|
27
38
|
},
|
|
28
39
|
"actionHook": {
|
|
29
40
|
"$ref": "../components/actionHook",
|
|
@@ -34,8 +45,14 @@
|
|
|
34
45
|
"description": "A webhook invoked for NOTIFY events during the REFER process, providing transfer progress updates."
|
|
35
46
|
}
|
|
36
47
|
},
|
|
37
|
-
"required": [
|
|
48
|
+
"required": [
|
|
49
|
+
"referTo"
|
|
50
|
+
],
|
|
38
51
|
"examples": [
|
|
39
|
-
{
|
|
52
|
+
{
|
|
53
|
+
"verb": "sip:refer",
|
|
54
|
+
"referTo": "sip:alice@example.com",
|
|
55
|
+
"actionHook": "/refer-complete"
|
|
56
|
+
}
|
|
40
57
|
]
|
|
41
58
|
}
|
|
@@ -1,16 +1,26 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/sip:request",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "SIP Request",
|
|
5
6
|
"description": "Sends a SIP request within the current dialog. Used to send INFO, NOTIFY, or other SIP methods to the remote party during an active call.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "sip:request"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"method": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The SIP method to send.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"INFO",
|
|
21
|
+
"NOTIFY",
|
|
22
|
+
"MESSAGE"
|
|
23
|
+
]
|
|
14
24
|
},
|
|
15
25
|
"body": {
|
|
16
26
|
"type": "string",
|
|
@@ -19,15 +29,26 @@
|
|
|
19
29
|
"headers": {
|
|
20
30
|
"type": "object",
|
|
21
31
|
"description": "Custom SIP headers to include in the request.",
|
|
22
|
-
"additionalProperties": {
|
|
32
|
+
"additionalProperties": {
|
|
33
|
+
"type": "string"
|
|
34
|
+
}
|
|
23
35
|
},
|
|
24
36
|
"actionHook": {
|
|
25
37
|
"$ref": "../components/actionHook",
|
|
26
38
|
"description": "A webhook invoked when the response to the SIP request is received."
|
|
27
39
|
}
|
|
28
40
|
},
|
|
29
|
-
"required": [
|
|
41
|
+
"required": [
|
|
42
|
+
"method"
|
|
43
|
+
],
|
|
30
44
|
"examples": [
|
|
31
|
-
{
|
|
45
|
+
{
|
|
46
|
+
"verb": "sip:request",
|
|
47
|
+
"method": "INFO",
|
|
48
|
+
"body": "Signal=1\nDuration=250",
|
|
49
|
+
"headers": {
|
|
50
|
+
"Content-Type": "application/dtmf-relay"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
32
53
|
]
|
|
33
54
|
}
|
|
@@ -1,31 +1,103 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/stream",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Stream",
|
|
5
6
|
"description": "Streams real-time call audio to an external websocket endpoint. Functionally equivalent to 'listen' — this is an alias provided for naming clarity when the intent is audio streaming rather than recording.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
"
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
"
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
"
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
"
|
|
25
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "stream"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
16
|
+
"url": {
|
|
17
|
+
"type": "string",
|
|
18
|
+
"format": "uri",
|
|
19
|
+
"description": "The websocket URL to stream audio to."
|
|
20
|
+
},
|
|
21
|
+
"actionHook": {
|
|
22
|
+
"$ref": "../components/actionHook",
|
|
23
|
+
"description": "A webhook invoked when the stream ends."
|
|
24
|
+
},
|
|
25
|
+
"wsAuth": {
|
|
26
|
+
"$ref": "../components/auth",
|
|
27
|
+
"description": "Authentication credentials for the websocket connection."
|
|
28
|
+
},
|
|
29
|
+
"mixType": {
|
|
30
|
+
"type": "string",
|
|
31
|
+
"enum": [
|
|
32
|
+
"mono",
|
|
33
|
+
"stereo",
|
|
34
|
+
"mixed"
|
|
35
|
+
],
|
|
36
|
+
"description": "How to mix audio channels."
|
|
37
|
+
},
|
|
38
|
+
"metadata": {
|
|
39
|
+
"type": "object",
|
|
40
|
+
"description": "Metadata to send with the initial connection.",
|
|
41
|
+
"additionalProperties": true
|
|
42
|
+
},
|
|
43
|
+
"sampleRate": {
|
|
44
|
+
"type": "number",
|
|
45
|
+
"description": "Audio sample rate in Hz.",
|
|
46
|
+
"examples": [
|
|
47
|
+
8000,
|
|
48
|
+
16000
|
|
49
|
+
]
|
|
50
|
+
},
|
|
51
|
+
"finishOnKey": {
|
|
52
|
+
"type": "string",
|
|
53
|
+
"description": "DTMF key that ends the stream."
|
|
54
|
+
},
|
|
55
|
+
"maxLength": {
|
|
56
|
+
"type": "number",
|
|
57
|
+
"description": "Maximum duration in seconds."
|
|
58
|
+
},
|
|
59
|
+
"passDtmf": {
|
|
60
|
+
"type": "boolean",
|
|
61
|
+
"description": "Forward DTMF events to the websocket."
|
|
62
|
+
},
|
|
63
|
+
"playBeep": {
|
|
64
|
+
"type": "boolean",
|
|
65
|
+
"description": "Play a beep before streaming begins."
|
|
66
|
+
},
|
|
67
|
+
"disableBidirectionalAudio": {
|
|
68
|
+
"type": "boolean",
|
|
69
|
+
"description": "Disable receiving audio from the websocket."
|
|
70
|
+
},
|
|
71
|
+
"bidirectionalAudio": {
|
|
72
|
+
"$ref": "../components/bidirectionalAudio",
|
|
73
|
+
"description": "Bidirectional audio configuration."
|
|
74
|
+
},
|
|
75
|
+
"timeout": {
|
|
76
|
+
"type": "number",
|
|
77
|
+
"description": "Inactivity timeout in seconds."
|
|
78
|
+
},
|
|
79
|
+
"transcribe": {
|
|
80
|
+
"$ref": "transcribe",
|
|
81
|
+
"description": "Nested transcribe verb — enables simultaneous real-time transcription of the streamed audio."
|
|
82
|
+
},
|
|
83
|
+
"earlyMedia": {
|
|
84
|
+
"type": "boolean",
|
|
85
|
+
"description": "Stream audio before the call is answered."
|
|
86
|
+
},
|
|
87
|
+
"channel": {
|
|
88
|
+
"type": "number",
|
|
89
|
+
"description": "Specific audio channel to stream. Used when streaming a single channel of a multi-channel call."
|
|
90
|
+
}
|
|
26
91
|
},
|
|
27
|
-
"required": [
|
|
92
|
+
"required": [
|
|
93
|
+
"url"
|
|
94
|
+
],
|
|
28
95
|
"examples": [
|
|
29
|
-
{
|
|
96
|
+
{
|
|
97
|
+
"verb": "stream",
|
|
98
|
+
"url": "wss://myapp.example.com/audio",
|
|
99
|
+
"sampleRate": 16000,
|
|
100
|
+
"mixType": "stereo"
|
|
101
|
+
}
|
|
30
102
|
]
|
|
31
103
|
}
|
|
@@ -1,21 +1,41 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/tag",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Tag",
|
|
5
6
|
"description": "Attaches arbitrary metadata to the current call. Tagged data is included in all subsequent webhook requests and in the call detail record (CDR). Useful for tracking business context, routing decisions, or analytics data through the call lifecycle.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "tag"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"data": {
|
|
11
17
|
"type": "object",
|
|
12
18
|
"description": "An object containing the metadata to attach to the call. Keys and values are application-defined.",
|
|
13
19
|
"additionalProperties": true,
|
|
14
|
-
"examples": [
|
|
20
|
+
"examples": [
|
|
21
|
+
{
|
|
22
|
+
"customerId": "12345",
|
|
23
|
+
"department": "support",
|
|
24
|
+
"priority": "high"
|
|
25
|
+
}
|
|
26
|
+
]
|
|
15
27
|
}
|
|
16
28
|
},
|
|
17
|
-
"required": [
|
|
29
|
+
"required": [
|
|
30
|
+
"data"
|
|
31
|
+
],
|
|
18
32
|
"examples": [
|
|
19
|
-
{
|
|
33
|
+
{
|
|
34
|
+
"verb": "tag",
|
|
35
|
+
"data": {
|
|
36
|
+
"customerId": "12345",
|
|
37
|
+
"intent": "billing-inquiry"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
20
40
|
]
|
|
21
41
|
}
|
|
@@ -1,12 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/transcribe",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Transcribe",
|
|
5
6
|
"description": "Enables real-time transcription of the call audio. Transcription results are sent to the transcriptionHook as they are produced. Runs as a background process — subsequent verbs execute immediately while transcription continues.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "transcribe"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"enable": {
|
|
11
17
|
"type": "boolean",
|
|
12
18
|
"description": "Enable or disable transcription. Used when transcribe is nested inside a config or dial verb to start or stop background transcription."
|
|
@@ -41,7 +47,10 @@
|
|
|
41
47
|
"recognizer": {
|
|
42
48
|
"vendor": "deepgram",
|
|
43
49
|
"language": "en-US",
|
|
44
|
-
"deepgramOptions": {
|
|
50
|
+
"deepgramOptions": {
|
|
51
|
+
"model": "nova-2",
|
|
52
|
+
"smartFormatting": true
|
|
53
|
+
}
|
|
45
54
|
}
|
|
46
55
|
}
|
|
47
56
|
]
|
|
@@ -1,20 +1,39 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/ultravox_s2s",
|
|
4
|
+
"minVersion": "10.1.0",
|
|
4
5
|
"title": "Ultravox S2S",
|
|
5
6
|
"description": "Shortcut for 'llm' with vendor automatically set to 'ultravox'. Connects the caller to an Ultravox 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": "ultravox_s2s",
|
|
16
|
+
"description": "The verb name."
|
|
17
|
+
},
|
|
18
|
+
"vendor": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"const": "ultravox",
|
|
21
|
+
"description": "The LLM vendor (always 'ultravox' for this shortcut)."
|
|
22
|
+
}
|
|
11
23
|
},
|
|
12
|
-
"required": [
|
|
24
|
+
"required": [
|
|
25
|
+
"llmOptions"
|
|
26
|
+
],
|
|
13
27
|
"examples": [
|
|
14
28
|
{
|
|
15
29
|
"verb": "ultravox_s2s",
|
|
16
30
|
"llmOptions": {
|
|
17
|
-
"messages": [
|
|
31
|
+
"messages": [
|
|
32
|
+
{
|
|
33
|
+
"role": "system",
|
|
34
|
+
"content": "You are a helpful voice assistant."
|
|
35
|
+
}
|
|
36
|
+
]
|
|
18
37
|
},
|
|
19
38
|
"actionHook": "/s2s-complete"
|
|
20
39
|
}
|