You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/apis/api/openapi.json
+19-59Lines changed: 19 additions & 59 deletions
Original file line number
Diff line number
Diff line change
@@ -6924,8 +6924,8 @@
6924
6924
"title": "Gather"
6925
6925
},
6926
6926
{
6927
-
"$ref": "#/components/schemas/HttpRequest",
6928
-
"title": "HttpRequest"
6927
+
"$ref": "#/components/schemas/ApiRequest",
6928
+
"title": "ApiRequest"
6929
6929
},
6930
6930
{
6931
6931
"$ref": "#/components/schemas/Hangup",
@@ -11004,6 +11004,11 @@
11004
11004
"description": "This is the timeout in seconds before a message from `idleMessages` is spoken. The clock starts when the assistant finishes speaking and remains active until the user speaks.\n\n@default 10",
11005
11005
"minimum": 5,
11006
11006
"maximum": 60
11007
+
},
11008
+
"silenceTimeoutMessage": {
11009
+
"type": "string",
11010
+
"description": "This is the message that the assistant will say if the call ends due to silence.\n\nIf unspecified, it will hang up without saying anything.",
11011
+
"maxLength": 1000
11007
11012
}
11008
11013
}
11009
11014
},
@@ -15412,54 +15417,6 @@
15412
15417
}
15413
15418
}
15414
15419
},
15415
-
"BuyPhoneNumberDTO": {
15416
-
"type": "object",
15417
-
"properties": {
15418
-
"fallbackDestination": {
15419
-
"description": "This is the fallback destination an inbound call will be transferred to if:\n1. `assistantId` is not set\n2. `squadId` is not set\n3. and, `assistant-request` message to the `serverUrl` fails\n\nIf this is not set and above conditions are met, the inbound call is hung up with an error message.",
"description": "This is the area code of the phone number to purchase.",
15434
-
"minLength": 3,
15435
-
"maxLength": 3
15436
-
},
15437
-
"name": {
15438
-
"type": "string",
15439
-
"description": "This is the name of the phone number. This is just for your own reference.",
15440
-
"maxLength": 40
15441
-
},
15442
-
"assistantId": {
15443
-
"type": "string",
15444
-
"description": "This is the assistant that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
15445
-
},
15446
-
"squadId": {
15447
-
"type": "string",
15448
-
"description": "This is the squad that will be used for incoming calls to this phone number.\n\nIf neither `assistantId` nor `squadId` is set, `assistant-request` will be sent to your Server URL. Check `ServerMessage` and `ServerMessageResponse` for the shape of the message and response that is expected."
15449
-
},
15450
-
"server": {
15451
-
"description": "This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.\n\nThe order of precedence is:\n\n1. assistant.server\n2. phoneNumber.server\n3. org.server",
15452
-
"allOf": [
15453
-
{
15454
-
"$ref": "#/components/schemas/Server"
15455
-
}
15456
-
]
15457
-
}
15458
-
},
15459
-
"required": [
15460
-
"areaCode"
15461
-
]
15462
-
},
15463
15420
"ImportVonagePhoneNumberDTO": {
15464
15421
"type": "object",
15465
15422
"properties": {
@@ -19225,6 +19182,9 @@
19225
19182
"type": "boolean",
19226
19183
"description": "This is whether or not the workflow should read back the gathered data to the user, and ask about its correctness."
19227
19184
},
19185
+
"maxRetries": {
19186
+
"type": "number"
19187
+
},
19228
19188
"name": {
19229
19189
"type": "string",
19230
19190
"maxLength": 80
@@ -19240,13 +19200,13 @@
19240
19200
"name"
19241
19201
]
19242
19202
},
19243
-
"HttpRequest": {
19203
+
"ApiRequest": {
19244
19204
"type": "object",
19245
19205
"properties": {
19246
19206
"type": {
19247
19207
"type": "string",
19248
19208
"enum": [
19249
-
"http-request"
19209
+
"api-request"
19250
19210
]
19251
19211
},
19252
19212
"method": {
@@ -19257,15 +19217,15 @@
19257
19217
},
19258
19218
"url": {
19259
19219
"type": "string",
19260
-
"description": "API endpoint to send requests to."
19220
+
"description": "Api endpoint to send requests to."
19261
19221
},
19262
19222
"headers": {
19263
19223
"type": "object",
19264
-
"description": "These are the custom headers to include in the HTTP request sent.\n\nEach key-value pair represents a header name and its value."
19224
+
"description": "These are the custom headers to include in the Api Request sent.\n\nEach key-value pair represents a header name and its value."
19265
19225
},
19266
19226
"body": {
19267
19227
"type": "object",
19268
-
"description": "This defined the JSON body of your HTTP request. For example, if `body_schema`\nincluded \"my_field\": \"my_gather_statement.user_age\", then the json body sent to the server would have that particular value assign to it.\nRight now, only data from gather statements are supported."
19228
+
"description": "This defined the JSON body of your Api Request. For example, if `body_schema`\nincluded \"my_field\": \"my_gather_statement.user_age\", then the json body sent to the server would have that particular value assign to it.\nRight now, only data from gather statements are supported."
0 commit comments