@vapi-ai/web 1.0.223 → 1.0.225

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.
Files changed (3) hide show
  1. package/api.ts +87 -6
  2. package/dist/api.d.ts +42 -6
  3. package/package.json +1 -1
package/api.ts CHANGED
@@ -83,6 +83,26 @@ export interface CreateAssistantDTO {
83
83
  | "daphne-rimeai"
84
84
  | "aurora-rimeai"
85
85
  | "nova-rimeai";
86
+ /**
87
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
88
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
89
+ */
90
+ language?:
91
+ | "en"
92
+ | "en-US"
93
+ | "en-AU"
94
+ | "en-GB"
95
+ | "en-NZ"
96
+ | "en-IN"
97
+ | "fr"
98
+ | "fr-CA"
99
+ | "de"
100
+ | "hi"
101
+ | "hi-Latn"
102
+ | "pt"
103
+ | "pt-BR"
104
+ | "es"
105
+ | "es-419";
86
106
  /**
87
107
  * This is the name of the assistant. This is just for your own reference.
88
108
  * @maxLength 40
@@ -117,12 +137,19 @@ export interface CreateAssistantDTO {
117
137
  * @maxLength 400
118
138
  */
119
139
  firstMessage?: string;
140
+ /**
141
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
142
+ *
143
+ * If unspecified, it will hang up.
144
+ * @maxLength 400
145
+ */
146
+ voicemailMessage?: string;
120
147
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
121
148
  interruptionsEnabled?: boolean;
122
149
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
123
150
  recordingEnabled?: boolean;
124
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
125
- voicemailEnabled?: boolean;
151
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
152
+ endCallFunctionEnabled?: boolean;
126
153
  }
127
154
 
128
155
  export interface CreateCustomerDTO {
@@ -322,6 +349,26 @@ export interface Assistant {
322
349
  | "daphne-rimeai"
323
350
  | "aurora-rimeai"
324
351
  | "nova-rimeai";
352
+ /**
353
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
354
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
355
+ */
356
+ language?:
357
+ | "en"
358
+ | "en-US"
359
+ | "en-AU"
360
+ | "en-GB"
361
+ | "en-NZ"
362
+ | "en-IN"
363
+ | "fr"
364
+ | "fr-CA"
365
+ | "de"
366
+ | "hi"
367
+ | "hi-Latn"
368
+ | "pt"
369
+ | "pt-BR"
370
+ | "es"
371
+ | "es-419";
325
372
  /**
326
373
  * This is the name of the assistant. This is just for your own reference.
327
374
  * @maxLength 40
@@ -356,12 +403,19 @@ export interface Assistant {
356
403
  * @maxLength 400
357
404
  */
358
405
  firstMessage?: string;
406
+ /**
407
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
408
+ *
409
+ * If unspecified, it will hang up.
410
+ * @maxLength 400
411
+ */
412
+ voicemailMessage?: string;
359
413
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
360
414
  interruptionsEnabled?: boolean;
361
415
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
362
416
  recordingEnabled?: boolean;
363
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
364
- voicemailEnabled?: boolean;
417
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
418
+ endCallFunctionEnabled?: boolean;
365
419
  /** This is the unique identifier for the assistant. */
366
420
  id: string;
367
421
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -418,6 +472,26 @@ export interface UpdateAssistantDTO {
418
472
  | "daphne-rimeai"
419
473
  | "aurora-rimeai"
420
474
  | "nova-rimeai";
475
+ /**
476
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
477
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
478
+ */
479
+ language?:
480
+ | "en"
481
+ | "en-US"
482
+ | "en-AU"
483
+ | "en-GB"
484
+ | "en-NZ"
485
+ | "en-IN"
486
+ | "fr"
487
+ | "fr-CA"
488
+ | "de"
489
+ | "hi"
490
+ | "hi-Latn"
491
+ | "pt"
492
+ | "pt-BR"
493
+ | "es"
494
+ | "es-419";
421
495
  /**
422
496
  * This is the name of the assistant. This is just for your own reference.
423
497
  * @maxLength 40
@@ -452,12 +526,19 @@ export interface UpdateAssistantDTO {
452
526
  * @maxLength 400
453
527
  */
454
528
  firstMessage?: string;
529
+ /**
530
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
531
+ *
532
+ * If unspecified, it will hang up.
533
+ * @maxLength 400
534
+ */
535
+ voicemailMessage?: string;
455
536
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
456
537
  interruptionsEnabled?: boolean;
457
538
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
458
539
  recordingEnabled?: boolean;
459
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
460
- voicemailEnabled?: boolean;
540
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
541
+ endCallFunctionEnabled?: boolean;
461
542
  }
462
543
 
463
544
  export interface BuyPhoneNumberDTO {
package/dist/api.d.ts CHANGED
@@ -40,6 +40,11 @@ export interface CreateAssistantDTO {
40
40
  * Basic Voices: `*-rimeai`
41
41
  */
42
42
  voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
43
+ /**
44
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
45
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
46
+ */
47
+ language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
43
48
  /**
44
49
  * This is the name of the assistant. This is just for your own reference.
45
50
  * @maxLength 40
@@ -74,12 +79,19 @@ export interface CreateAssistantDTO {
74
79
  * @maxLength 400
75
80
  */
76
81
  firstMessage?: string;
82
+ /**
83
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
84
+ *
85
+ * If unspecified, it will hang up.
86
+ * @maxLength 400
87
+ */
88
+ voicemailMessage?: string;
77
89
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
78
90
  interruptionsEnabled?: boolean;
79
91
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
80
92
  recordingEnabled?: boolean;
81
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
82
- voicemailEnabled?: boolean;
93
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
94
+ endCallFunctionEnabled?: boolean;
83
95
  }
84
96
  export interface CreateCustomerDTO {
85
97
  /** This is the number of the customer. */
@@ -244,6 +256,11 @@ export interface Assistant {
244
256
  * Basic Voices: `*-rimeai`
245
257
  */
246
258
  voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
259
+ /**
260
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
261
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
262
+ */
263
+ language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
247
264
  /**
248
265
  * This is the name of the assistant. This is just for your own reference.
249
266
  * @maxLength 40
@@ -278,12 +295,19 @@ export interface Assistant {
278
295
  * @maxLength 400
279
296
  */
280
297
  firstMessage?: string;
298
+ /**
299
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
300
+ *
301
+ * If unspecified, it will hang up.
302
+ * @maxLength 400
303
+ */
304
+ voicemailMessage?: string;
281
305
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
282
306
  interruptionsEnabled?: boolean;
283
307
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
284
308
  recordingEnabled?: boolean;
285
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
286
- voicemailEnabled?: boolean;
309
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
310
+ endCallFunctionEnabled?: boolean;
287
311
  /** This is the unique identifier for the assistant. */
288
312
  id: string;
289
313
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -310,6 +334,11 @@ export interface UpdateAssistantDTO {
310
334
  * Basic Voices: `*-rimeai`
311
335
  */
312
336
  voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
337
+ /**
338
+ * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
339
+ * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
340
+ */
341
+ language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
313
342
  /**
314
343
  * This is the name of the assistant. This is just for your own reference.
315
344
  * @maxLength 40
@@ -344,12 +373,19 @@ export interface UpdateAssistantDTO {
344
373
  * @maxLength 400
345
374
  */
346
375
  firstMessage?: string;
376
+ /**
377
+ * This is the message that the assistant will say if the call is forwarded to voicemail.
378
+ *
379
+ * If unspecified, it will hang up.
380
+ * @maxLength 400
381
+ */
382
+ voicemailMessage?: string;
347
383
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
348
384
  interruptionsEnabled?: boolean;
349
385
  /** This sets whether calls are recorded for the assistant. Defaults to true. */
350
386
  recordingEnabled?: boolean;
351
- /** This sets whether assistant leaves voicemails when call is not picked up. Defaults to true. */
352
- voicemailEnabled?: boolean;
387
+ /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
388
+ endCallFunctionEnabled?: boolean;
353
389
  }
354
390
  export interface BuyPhoneNumberDTO {
355
391
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vapi-ai/web",
3
- "version": "1.0.223",
3
+ "version": "1.0.225",
4
4
  "description": "",
5
5
  "main": "dist/vapi.js",
6
6
  "types": "dist/vapi.d.ts",