@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
package/package.json
CHANGED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://jambonz.org/schema/callbacks/amd",
|
|
4
|
+
"title": "AMD ActionHook Payload",
|
|
5
|
+
"description": "Payload sent to the AMD actionHook when an answering machine detection event occurs. Multiple events may fire during a single call (e.g. amd_machine_detected followed by amd_machine_stopped_speaking or amd_tone_detected).",
|
|
6
|
+
"allOf": [{ "$ref": "base" }],
|
|
7
|
+
"type": "object",
|
|
8
|
+
"properties": {
|
|
9
|
+
"type": {
|
|
10
|
+
"type": "string",
|
|
11
|
+
"description": "The AMD event type. IMPORTANT: This field is 'type', NOT 'amd_type'.",
|
|
12
|
+
"enum": [
|
|
13
|
+
"amd_human_detected",
|
|
14
|
+
"amd_machine_detected",
|
|
15
|
+
"amd_no_speech_detected",
|
|
16
|
+
"amd_decision_timeout",
|
|
17
|
+
"amd_machine_stopped_speaking",
|
|
18
|
+
"amd_tone_detected",
|
|
19
|
+
"amd_tone_timeout",
|
|
20
|
+
"amd_error",
|
|
21
|
+
"amd_stopped"
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
"reason": {
|
|
25
|
+
"type": "string",
|
|
26
|
+
"description": "Reason for the detection result (e.g. 'short greeting', 'long greeting', 'hint', 'digit count'). Present on amd_human_detected and amd_machine_detected events."
|
|
27
|
+
},
|
|
28
|
+
"greeting": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"description": "The transcribed greeting text. Present on amd_human_detected and amd_machine_detected events."
|
|
31
|
+
},
|
|
32
|
+
"hint": {
|
|
33
|
+
"type": "string",
|
|
34
|
+
"description": "The voicemail hint that matched, if detection was triggered by hint matching."
|
|
35
|
+
},
|
|
36
|
+
"language": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"description": "Language code from the transcription (e.g. 'en-US'). Present on amd_human_detected and amd_machine_detected events."
|
|
39
|
+
},
|
|
40
|
+
"frequency": {
|
|
41
|
+
"type": "number",
|
|
42
|
+
"description": "Frequency of the detected beep in Hz. Present on amd_tone_detected events."
|
|
43
|
+
},
|
|
44
|
+
"variance": {
|
|
45
|
+
"type": "number",
|
|
46
|
+
"description": "Frequency variance of the detected beep. Present on amd_tone_detected events."
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"required": ["type"]
|
|
50
|
+
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/components/amd",
|
|
4
4
|
"title": "Answering Machine Detection",
|
|
5
|
-
"description": "Configuration for answering machine detection (AMD). Detects whether an outbound or inbound call was answered by a human or a machine. Used as a nested property on the 'config' or 'dial' verb.",
|
|
5
|
+
"description": "Configuration for answering machine detection (AMD). Detects whether an outbound or inbound call was answered by a human or a machine. Used as a nested property on the 'config' or 'dial' verb. IMPORTANT: AMD runs asynchronously in the background. When using AMD with the 'config' verb, you MUST follow it with a 'pause' verb (e.g. pause({ length: 25 })) to keep the call alive while AMD detection runs. Without a pause, the call will end immediately after config completes.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"actionHook": {
|
|
@@ -1,20 +1,34 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/alert",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Alert",
|
|
5
6
|
"description": "Sends a 180 Ringing provisional response with an Alert-Info header. Used to trigger a specific ring tone or alert behavior on the caller's device before the call is answered.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "alert"
|
|
11
|
+
},
|
|
12
|
+
"id": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "An optional unique identifier for this verb instance."
|
|
15
|
+
},
|
|
10
16
|
"message": {
|
|
11
17
|
"type": "string",
|
|
12
18
|
"description": "The value to include in the Alert-Info header.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"info=alert-internal",
|
|
21
|
+
"http://example.com/ringtone.wav"
|
|
22
|
+
]
|
|
14
23
|
}
|
|
15
24
|
},
|
|
16
|
-
"required": [
|
|
25
|
+
"required": [
|
|
26
|
+
"message"
|
|
27
|
+
],
|
|
17
28
|
"examples": [
|
|
18
|
-
{
|
|
29
|
+
{
|
|
30
|
+
"verb": "alert",
|
|
31
|
+
"message": "info=alert-internal"
|
|
32
|
+
}
|
|
19
33
|
]
|
|
20
34
|
}
|
|
@@ -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/answer",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Answer",
|
|
5
6
|
"description": "Answers an incoming call (sends a 200 OK to the SIP INVITE). Most verbs implicitly answer the call, so this verb is only needed when you want to explicitly control when the call is answered — for example, to play early media before answering.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "answer"
|
|
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": "answer"
|
|
20
|
+
}
|
|
21
|
+
]
|
|
12
22
|
}
|
|
@@ -1,35 +1,99 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/conference",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Conference",
|
|
5
6
|
"description": "Places the caller into a multi-party conference room. Multiple callers in the same named conference can speak to each other. Supports features like muting, recording, waiting rooms, and participant limits.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "conference"
|
|
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 conference room. All callers joining the same named conference are connected together.",
|
|
13
|
-
"examples": [
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
"
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
"
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
"
|
|
19
|
+
"examples": [
|
|
20
|
+
"team-standup",
|
|
21
|
+
"customer-call-12345"
|
|
22
|
+
]
|
|
23
|
+
},
|
|
24
|
+
"beep": {
|
|
25
|
+
"type": "boolean",
|
|
26
|
+
"description": "If true, play a beep when participants join or leave."
|
|
27
|
+
},
|
|
28
|
+
"memberTag": {
|
|
29
|
+
"type": "string",
|
|
30
|
+
"description": "A tag to identify this participant. Can be used to target specific members for actions like muting or whispering."
|
|
31
|
+
},
|
|
32
|
+
"speakOnlyTo": {
|
|
33
|
+
"type": "string",
|
|
34
|
+
"description": "If set, this participant's audio is only heard by the member with the specified memberTag. Creates a private whisper channel."
|
|
35
|
+
},
|
|
36
|
+
"startConferenceOnEnter": {
|
|
37
|
+
"type": "boolean",
|
|
38
|
+
"description": "If true (default), the conference starts when this participant joins. If false, this participant waits silently until a participant with startConferenceOnEnter=true joins."
|
|
39
|
+
},
|
|
40
|
+
"endConferenceOnExit": {
|
|
41
|
+
"type": "boolean",
|
|
42
|
+
"description": "If true, the conference ends for all participants when this participant leaves."
|
|
43
|
+
},
|
|
44
|
+
"endConferenceDuration": {
|
|
45
|
+
"type": "number",
|
|
46
|
+
"description": "Maximum duration of the conference in seconds."
|
|
47
|
+
},
|
|
48
|
+
"maxParticipants": {
|
|
49
|
+
"type": "number",
|
|
50
|
+
"description": "Maximum number of participants allowed in the conference."
|
|
51
|
+
},
|
|
52
|
+
"joinMuted": {
|
|
53
|
+
"type": "boolean",
|
|
54
|
+
"description": "If true, this participant joins the conference muted."
|
|
55
|
+
},
|
|
56
|
+
"actionHook": {
|
|
57
|
+
"$ref": "../components/actionHook",
|
|
58
|
+
"description": "A webhook invoked when this participant leaves the conference."
|
|
59
|
+
},
|
|
60
|
+
"waitHook": {
|
|
61
|
+
"$ref": "../components/actionHook",
|
|
62
|
+
"description": "A webhook invoked while this participant is waiting for the conference to start. Should return verbs to play (e.g. hold music)."
|
|
63
|
+
},
|
|
64
|
+
"statusEvents": {
|
|
65
|
+
"type": "array",
|
|
66
|
+
"items": {
|
|
67
|
+
"type": "string"
|
|
68
|
+
},
|
|
69
|
+
"description": "List of conference events to receive via the statusHook."
|
|
70
|
+
},
|
|
71
|
+
"statusHook": {
|
|
72
|
+
"$ref": "../components/actionHook",
|
|
73
|
+
"description": "A webhook to receive conference status events (joins, leaves, etc.)."
|
|
74
|
+
},
|
|
75
|
+
"enterHook": {
|
|
76
|
+
"$ref": "../components/actionHook",
|
|
77
|
+
"description": "A webhook invoked when this participant first enters the conference."
|
|
78
|
+
},
|
|
79
|
+
"record": {
|
|
80
|
+
"type": "object",
|
|
81
|
+
"description": "Recording configuration for the conference.",
|
|
82
|
+
"additionalProperties": true
|
|
83
|
+
},
|
|
84
|
+
"listen": {
|
|
85
|
+
"type": "object",
|
|
86
|
+
"description": "Audio streaming configuration for the conference.",
|
|
87
|
+
"additionalProperties": true
|
|
88
|
+
},
|
|
89
|
+
"distributeDtmf": {
|
|
90
|
+
"type": "boolean",
|
|
91
|
+
"description": "If true, DTMF events from this participant are distributed to all other participants."
|
|
92
|
+
}
|
|
31
93
|
},
|
|
32
|
-
"required": [
|
|
94
|
+
"required": [
|
|
95
|
+
"name"
|
|
96
|
+
],
|
|
33
97
|
"examples": [
|
|
34
98
|
{
|
|
35
99
|
"verb": "conference",
|
|
@@ -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/config",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Config",
|
|
5
6
|
"description": "Sets session-level defaults for the call. Configures default TTS, STT, VAD, recording, streaming, and other session-wide settings. These defaults apply to all subsequent verbs unless overridden at the verb level. Typically the first verb in an application. Can be used multiple times during a call to change settings.",
|
|
6
7
|
"type": "object",
|
|
@@ -25,25 +26,41 @@
|
|
|
25
26
|
"type": "object",
|
|
26
27
|
"description": "Default barge-in configuration. When enabled, callers can interrupt playing prompts with speech or DTMF.",
|
|
27
28
|
"properties": {
|
|
28
|
-
"enable": {
|
|
29
|
+
"enable": {
|
|
30
|
+
"type": "boolean"
|
|
31
|
+
},
|
|
29
32
|
"sticky": {
|
|
30
33
|
"type": "boolean",
|
|
31
34
|
"description": "If true, barge-in settings persist across verbs rather than resetting after each verb."
|
|
32
35
|
},
|
|
33
|
-
"actionHook": {
|
|
36
|
+
"actionHook": {
|
|
37
|
+
"$ref": "../components/actionHook"
|
|
38
|
+
},
|
|
34
39
|
"input": {
|
|
35
40
|
"type": "array",
|
|
36
|
-
"items": {
|
|
41
|
+
"items": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"enum": [
|
|
44
|
+
"speech",
|
|
45
|
+
"digits"
|
|
46
|
+
]
|
|
47
|
+
}
|
|
37
48
|
},
|
|
38
|
-
"minBargeinWordCount": {
|
|
49
|
+
"minBargeinWordCount": {
|
|
50
|
+
"type": "number"
|
|
51
|
+
}
|
|
39
52
|
}
|
|
40
53
|
},
|
|
41
54
|
"ttsStream": {
|
|
42
55
|
"type": "object",
|
|
43
56
|
"description": "Default TTS streaming configuration for the session.",
|
|
44
57
|
"properties": {
|
|
45
|
-
"enable": {
|
|
46
|
-
|
|
58
|
+
"enable": {
|
|
59
|
+
"type": "boolean"
|
|
60
|
+
},
|
|
61
|
+
"synthesizer": {
|
|
62
|
+
"$ref": "../components/synthesizer"
|
|
63
|
+
}
|
|
47
64
|
}
|
|
48
65
|
},
|
|
49
66
|
"record": {
|
|
@@ -85,8 +102,15 @@
|
|
|
85
102
|
},
|
|
86
103
|
"reset": {
|
|
87
104
|
"oneOf": [
|
|
88
|
-
{
|
|
89
|
-
|
|
105
|
+
{
|
|
106
|
+
"type": "string"
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"type": "array",
|
|
110
|
+
"items": {
|
|
111
|
+
"type": "string"
|
|
112
|
+
}
|
|
113
|
+
}
|
|
90
114
|
],
|
|
91
115
|
"description": "Reset specific session-level settings to their defaults. Pass a setting name or array of setting names to reset."
|
|
92
116
|
},
|
|
@@ -105,8 +129,12 @@
|
|
|
105
129
|
},
|
|
106
130
|
"boostAudioSignal": {
|
|
107
131
|
"oneOf": [
|
|
108
|
-
{
|
|
109
|
-
|
|
132
|
+
{
|
|
133
|
+
"type": "number"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"type": "string"
|
|
137
|
+
}
|
|
110
138
|
],
|
|
111
139
|
"description": "Boost (or attenuate) the audio signal in dB for the session."
|
|
112
140
|
},
|
|
@@ -130,20 +158,36 @@
|
|
|
130
158
|
"type": "object",
|
|
131
159
|
"description": "Noise isolation configuration to reduce background noise on the caller's audio.",
|
|
132
160
|
"properties": {
|
|
133
|
-
"enable": {
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
"
|
|
161
|
+
"enable": {
|
|
162
|
+
"type": "boolean"
|
|
163
|
+
},
|
|
164
|
+
"vendor": {
|
|
165
|
+
"type": "string"
|
|
166
|
+
},
|
|
167
|
+
"level": {
|
|
168
|
+
"type": "number"
|
|
169
|
+
},
|
|
170
|
+
"model": {
|
|
171
|
+
"type": "string"
|
|
172
|
+
}
|
|
137
173
|
}
|
|
138
174
|
},
|
|
139
175
|
"turnTaking": {
|
|
140
176
|
"type": "object",
|
|
141
177
|
"description": "Turn-taking detection configuration for conversational AI applications.",
|
|
142
178
|
"properties": {
|
|
143
|
-
"enable": {
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
"
|
|
179
|
+
"enable": {
|
|
180
|
+
"type": "boolean"
|
|
181
|
+
},
|
|
182
|
+
"vendor": {
|
|
183
|
+
"type": "string"
|
|
184
|
+
},
|
|
185
|
+
"threshold": {
|
|
186
|
+
"type": "number"
|
|
187
|
+
},
|
|
188
|
+
"model": {
|
|
189
|
+
"type": "string"
|
|
190
|
+
}
|
|
147
191
|
}
|
|
148
192
|
}
|
|
149
193
|
},
|
|
@@ -1,20 +1,79 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://jambonz.org/schema/verbs/deepgram_s2s",
|
|
4
|
+
"minVersion": "10.1.0",
|
|
4
5
|
"title": "Deepgram S2S",
|
|
5
6
|
"description": "Shortcut for 'llm' with vendor automatically set to 'deepgram'. Connects the caller to a Deepgram 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": "deepgram_s2s",
|
|
16
|
+
"description": "The verb name."
|
|
17
|
+
},
|
|
18
|
+
"vendor": {
|
|
19
|
+
"type": "string",
|
|
20
|
+
"const": "deepgram",
|
|
21
|
+
"description": "The LLM vendor (always 'deepgram' for this shortcut)."
|
|
22
|
+
},
|
|
23
|
+
"llmOptions": {
|
|
24
|
+
"type": "object",
|
|
25
|
+
"description": "IMPORTANT: Deepgram does NOT use a 'messages' array. The llmOptions must contain a 'Settings' object with 'agent.think' (LLM provider, model, and prompt) and 'agent.speak' (TTS provider and voice model). The system prompt goes in Settings.agent.think.prompt, NOT in messages.",
|
|
26
|
+
"additionalProperties": true,
|
|
27
|
+
"examples": [
|
|
28
|
+
{
|
|
29
|
+
"Settings": {
|
|
30
|
+
"agent": {
|
|
31
|
+
"think": {
|
|
32
|
+
"provider": {
|
|
33
|
+
"type": "open_ai",
|
|
34
|
+
"model": "gpt-4o"
|
|
35
|
+
},
|
|
36
|
+
"prompt": "You are a helpful voice assistant."
|
|
37
|
+
},
|
|
38
|
+
"speak": {
|
|
39
|
+
"provider": {
|
|
40
|
+
"type": "deepgram",
|
|
41
|
+
"model": "aura-2-thalia-en"
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
]
|
|
48
|
+
}
|
|
11
49
|
},
|
|
12
|
-
"required": [
|
|
50
|
+
"required": [
|
|
51
|
+
"llmOptions"
|
|
52
|
+
],
|
|
13
53
|
"examples": [
|
|
14
54
|
{
|
|
15
55
|
"verb": "deepgram_s2s",
|
|
56
|
+
"auth": {
|
|
57
|
+
"apiKey": "your-deepgram-api-key"
|
|
58
|
+
},
|
|
16
59
|
"llmOptions": {
|
|
17
|
-
"
|
|
60
|
+
"Settings": {
|
|
61
|
+
"agent": {
|
|
62
|
+
"think": {
|
|
63
|
+
"provider": {
|
|
64
|
+
"type": "open_ai",
|
|
65
|
+
"model": "gpt-4o"
|
|
66
|
+
},
|
|
67
|
+
"prompt": "You are a helpful voice assistant."
|
|
68
|
+
},
|
|
69
|
+
"speak": {
|
|
70
|
+
"provider": {
|
|
71
|
+
"type": "deepgram",
|
|
72
|
+
"model": "aura-2-thalia-en"
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
18
77
|
},
|
|
19
78
|
"actionHook": "/s2s-complete"
|
|
20
79
|
}
|
|
@@ -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/dequeue",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Dequeue",
|
|
5
6
|
"description": "Removes a caller from a named queue and bridges them to the current call. Typically used by an agent or operator call flow to connect with the next waiting caller.",
|
|
6
7
|
"type": "object",
|
|
7
8
|
"properties": {
|
|
8
|
-
"verb": {
|
|
9
|
-
|
|
9
|
+
"verb": {
|
|
10
|
+
"const": "dequeue"
|
|
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 dequeue from.",
|
|
13
|
-
"examples": [
|
|
19
|
+
"examples": [
|
|
20
|
+
"support",
|
|
21
|
+
"sales"
|
|
22
|
+
]
|
|
14
23
|
},
|
|
15
24
|
"actionHook": {
|
|
16
25
|
"$ref": "../components/actionHook",
|
|
@@ -29,8 +38,14 @@
|
|
|
29
38
|
"description": "Dequeue a specific call by its call SID, rather than the next caller in line."
|
|
30
39
|
}
|
|
31
40
|
},
|
|
32
|
-
"required": [
|
|
41
|
+
"required": [
|
|
42
|
+
"name"
|
|
43
|
+
],
|
|
33
44
|
"examples": [
|
|
34
|
-
{
|
|
45
|
+
{
|
|
46
|
+
"verb": "dequeue",
|
|
47
|
+
"name": "support",
|
|
48
|
+
"beep": true
|
|
49
|
+
}
|
|
35
50
|
]
|
|
36
51
|
}
|
|
@@ -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/dial",
|
|
4
|
+
"minVersion": "0.9.6",
|
|
4
5
|
"title": "Dial",
|
|
5
6
|
"description": "Initiates an outbound call to one or more targets and bridges the caller to the first target that answers. Targets can be phone numbers (PSTN), SIP endpoints, registered users, or Microsoft Teams users. Supports simultaneous ringing, call screening, recording, and DTMF capture during the bridged call.",
|
|
6
7
|
"type": "object",
|
|
@@ -15,7 +16,9 @@
|
|
|
15
16
|
},
|
|
16
17
|
"target": {
|
|
17
18
|
"type": "array",
|
|
18
|
-
"items": {
|
|
19
|
+
"items": {
|
|
20
|
+
"$ref": "../components/target"
|
|
21
|
+
},
|
|
19
22
|
"description": "One or more call targets to dial. If multiple targets are specified, they are rung simultaneously and the first to answer is connected. The rest are canceled.",
|
|
20
23
|
"minItems": 1
|
|
21
24
|
},
|
|
@@ -34,7 +37,9 @@
|
|
|
34
37
|
"callerId": {
|
|
35
38
|
"type": "string",
|
|
36
39
|
"description": "The caller ID (phone number) to present on the outbound call. Overrides the default caller ID.",
|
|
37
|
-
"examples": [
|
|
40
|
+
"examples": [
|
|
41
|
+
"+15085551212"
|
|
42
|
+
]
|
|
38
43
|
},
|
|
39
44
|
"callerName": {
|
|
40
45
|
"type": "string",
|
|
@@ -65,7 +70,9 @@
|
|
|
65
70
|
"headers": {
|
|
66
71
|
"type": "object",
|
|
67
72
|
"description": "Custom SIP headers to include on the outbound INVITE.",
|
|
68
|
-
"additionalProperties": {
|
|
73
|
+
"additionalProperties": {
|
|
74
|
+
"type": "string"
|
|
75
|
+
}
|
|
69
76
|
},
|
|
70
77
|
"anchorMedia": {
|
|
71
78
|
"type": "boolean",
|
|
@@ -77,11 +84,18 @@
|
|
|
77
84
|
},
|
|
78
85
|
"boostAudioSignal": {
|
|
79
86
|
"oneOf": [
|
|
80
|
-
{
|
|
81
|
-
|
|
87
|
+
{
|
|
88
|
+
"type": "number"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"type": "string"
|
|
92
|
+
}
|
|
82
93
|
],
|
|
83
94
|
"description": "Boost (or attenuate) the audio signal in dB. Positive values increase volume, negative values decrease it.",
|
|
84
|
-
"examples": [
|
|
95
|
+
"examples": [
|
|
96
|
+
6,
|
|
97
|
+
-3
|
|
98
|
+
]
|
|
85
99
|
},
|
|
86
100
|
"listen": {
|
|
87
101
|
"$ref": "listen",
|
|
@@ -98,17 +112,24 @@
|
|
|
98
112
|
"timeLimit": {
|
|
99
113
|
"type": "number",
|
|
100
114
|
"description": "Maximum duration in seconds for the bridged call. The call is automatically hung up when this limit is reached.",
|
|
101
|
-
"examples": [
|
|
115
|
+
"examples": [
|
|
116
|
+
3600
|
|
117
|
+
]
|
|
102
118
|
},
|
|
103
119
|
"timeout": {
|
|
104
120
|
"type": "number",
|
|
105
121
|
"description": "Time in seconds to wait for the target to answer before giving up.",
|
|
106
|
-
"examples": [
|
|
122
|
+
"examples": [
|
|
123
|
+
30,
|
|
124
|
+
60
|
|
125
|
+
]
|
|
107
126
|
},
|
|
108
127
|
"proxy": {
|
|
109
128
|
"type": "string",
|
|
110
129
|
"description": "A SIP proxy to route the outbound call through.",
|
|
111
|
-
"examples": [
|
|
130
|
+
"examples": [
|
|
131
|
+
"sip:proxy.example.com"
|
|
132
|
+
]
|
|
112
133
|
},
|
|
113
134
|
"amd": {
|
|
114
135
|
"$ref": "../components/amd",
|
|
@@ -116,7 +137,9 @@
|
|
|
116
137
|
},
|
|
117
138
|
"dub": {
|
|
118
139
|
"type": "array",
|
|
119
|
-
"items": {
|
|
140
|
+
"items": {
|
|
141
|
+
"$ref": "dub"
|
|
142
|
+
},
|
|
120
143
|
"description": "Nested dub verbs — audio dubbing configuration for mixing additional audio tracks into the bridged call."
|
|
121
144
|
},
|
|
122
145
|
"tag": {
|
|
@@ -129,12 +152,17 @@
|
|
|
129
152
|
"description": "If true, forward the P-Asserted-Identity header from the inbound call to the outbound call."
|
|
130
153
|
}
|
|
131
154
|
},
|
|
132
|
-
"required": [
|
|
155
|
+
"required": [
|
|
156
|
+
"target"
|
|
157
|
+
],
|
|
133
158
|
"examples": [
|
|
134
159
|
{
|
|
135
160
|
"verb": "dial",
|
|
136
161
|
"target": [
|
|
137
|
-
{
|
|
162
|
+
{
|
|
163
|
+
"type": "phone",
|
|
164
|
+
"number": "+15085551212"
|
|
165
|
+
}
|
|
138
166
|
],
|
|
139
167
|
"answerOnBridge": true,
|
|
140
168
|
"timeout": 30,
|
|
@@ -143,8 +171,14 @@
|
|
|
143
171
|
{
|
|
144
172
|
"verb": "dial",
|
|
145
173
|
"target": [
|
|
146
|
-
{
|
|
147
|
-
|
|
174
|
+
{
|
|
175
|
+
"type": "sip",
|
|
176
|
+
"sipUri": "sip:alice@example.com"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"type": "sip",
|
|
180
|
+
"sipUri": "sip:bob@example.com"
|
|
181
|
+
}
|
|
148
182
|
],
|
|
149
183
|
"confirmHook": "/screen-call",
|
|
150
184
|
"timeLimit": 3600
|