syllable-sdk 1.0.3 → 1.0.4-rc.2
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/README.md +28 -13
- package/bin/mcp-server.js +1027 -16
- package/bin/mcp-server.js.map +47 -26
- package/docs/sdks/batches/README.md +4 -4
- package/docs/sdks/channels/README.md +16 -0
- package/docs/sdks/languagegroups/README.md +31 -19
- package/docs/sdks/voicegroups/README.md +551 -0
- package/docs/sdks/workflows/README.md +8 -8
- package/examples/package-lock.json +1 -1
- package/funcs/languageGroupsCreate.d.ts +3 -1
- package/funcs/languageGroupsCreate.d.ts.map +1 -1
- package/funcs/languageGroupsCreate.js +3 -1
- package/funcs/languageGroupsCreate.js.map +1 -1
- package/funcs/languageGroupsDelete.d.ts +3 -1
- package/funcs/languageGroupsDelete.d.ts.map +1 -1
- package/funcs/languageGroupsDelete.js +3 -1
- package/funcs/languageGroupsDelete.js.map +1 -1
- package/funcs/languageGroupsGetById.d.ts +3 -1
- package/funcs/languageGroupsGetById.d.ts.map +1 -1
- package/funcs/languageGroupsGetById.js +3 -1
- package/funcs/languageGroupsGetById.js.map +1 -1
- package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +4 -2
- package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.d.ts.map +1 -1
- package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js +4 -2
- package/funcs/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
- package/funcs/languageGroupsList.d.ts +3 -1
- package/funcs/languageGroupsList.d.ts.map +1 -1
- package/funcs/languageGroupsList.js +3 -1
- package/funcs/languageGroupsList.js.map +1 -1
- package/funcs/languageGroupsUpdate.d.ts +3 -1
- package/funcs/languageGroupsUpdate.d.ts.map +1 -1
- package/funcs/languageGroupsUpdate.js +3 -1
- package/funcs/languageGroupsUpdate.js.map +1 -1
- package/funcs/voiceGroupsCreate.d.ts +18 -0
- package/funcs/voiceGroupsCreate.d.ts.map +1 -0
- package/funcs/voiceGroupsCreate.js +118 -0
- package/funcs/voiceGroupsCreate.js.map +1 -0
- package/funcs/voiceGroupsDelete.d.ts +18 -0
- package/funcs/voiceGroupsDelete.d.ts.map +1 -0
- package/funcs/voiceGroupsDelete.js +128 -0
- package/funcs/voiceGroupsDelete.js.map +1 -0
- package/funcs/voiceGroupsGetById.d.ts +19 -0
- package/funcs/voiceGroupsGetById.d.ts.map +1 -0
- package/funcs/voiceGroupsGetById.js +124 -0
- package/funcs/voiceGroupsGetById.js.map +1 -0
- package/funcs/voiceGroupsList.d.ts +19 -0
- package/funcs/voiceGroupsList.d.ts.map +1 -0
- package/funcs/voiceGroupsList.js +130 -0
- package/funcs/voiceGroupsList.js.map +1 -0
- package/funcs/voiceGroupsUpdate.d.ts +18 -0
- package/funcs/voiceGroupsUpdate.d.ts.map +1 -0
- package/funcs/voiceGroupsUpdate.js +118 -0
- package/funcs/voiceGroupsUpdate.js.map +1 -0
- package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +18 -0
- package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
- package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js +119 -0
- package/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.d.ts.map +1 -1
- package/mcp-server/server.js +13 -1
- package/mcp-server/server.js.map +1 -1
- package/mcp-server/tools/languageGroupsCreate.js +1 -1
- package/mcp-server/tools/languageGroupsCreate.js.map +1 -1
- package/mcp-server/tools/languageGroupsDelete.js +1 -1
- package/mcp-server/tools/languageGroupsDelete.js.map +1 -1
- package/mcp-server/tools/languageGroupsGetById.js +1 -1
- package/mcp-server/tools/languageGroupsGetById.js.map +1 -1
- package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.d.ts +1 -1
- package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js +2 -2
- package/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.js.map +1 -1
- package/mcp-server/tools/languageGroupsList.js +1 -1
- package/mcp-server/tools/languageGroupsList.js.map +1 -1
- package/mcp-server/tools/languageGroupsUpdate.js +1 -1
- package/mcp-server/tools/languageGroupsUpdate.js.map +1 -1
- package/mcp-server/tools/voiceGroupsCreate.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsCreate.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsCreate.js +64 -0
- package/mcp-server/tools/voiceGroupsCreate.js.map +1 -0
- package/mcp-server/tools/voiceGroupsDelete.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsDelete.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsDelete.js +64 -0
- package/mcp-server/tools/voiceGroupsDelete.js.map +1 -0
- package/mcp-server/tools/voiceGroupsGetById.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsGetById.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsGetById.js +64 -0
- package/mcp-server/tools/voiceGroupsGetById.js.map +1 -0
- package/mcp-server/tools/voiceGroupsList.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsList.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsList.js +64 -0
- package/mcp-server/tools/voiceGroupsList.js.map +1 -0
- package/mcp-server/tools/voiceGroupsUpdate.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsUpdate.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsUpdate.js +64 -0
- package/mcp-server/tools/voiceGroupsUpdate.js.map +1 -0
- package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts +8 -0
- package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.d.ts.map +1 -0
- package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js +64 -0
- package/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.js.map +1 -0
- package/models/components/channelservices.d.ts +3 -0
- package/models/components/channelservices.d.ts.map +1 -1
- package/models/components/channelservices.js +1 -0
- package/models/components/channelservices.js.map +1 -1
- package/models/components/index.d.ts +6 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +6 -0
- package/models/components/index.js.map +1 -1
- package/models/components/languagegroupcreaterequest.d.ts +1 -1
- package/models/components/languagegroupproperties.d.ts +2 -2
- package/models/components/languagegroupproperties.js +1 -1
- package/models/components/languagegroupresponse.d.ts +3 -3
- package/models/components/languagegroupupdaterequest.d.ts +1 -1
- package/models/components/languagesamplecreaterequest.d.ts +68 -0
- package/models/components/languagesamplecreaterequest.d.ts.map +1 -0
- package/models/components/languagesamplecreaterequest.js +103 -0
- package/models/components/languagesamplecreaterequest.js.map +1 -0
- package/models/components/listresponsevoicegroupresponse.d.ts +53 -0
- package/models/components/listresponsevoicegroupresponse.d.ts.map +1 -0
- package/models/components/listresponsevoicegroupresponse.js +91 -0
- package/models/components/listresponsevoicegroupresponse.js.map +1 -0
- package/models/components/organizationchannelconfig.d.ts +9 -0
- package/models/components/organizationchannelconfig.d.ts.map +1 -1
- package/models/components/organizationchannelconfig.js +4 -0
- package/models/components/organizationchannelconfig.js.map +1 -1
- package/models/components/voicegroupcreaterequest.d.ts +51 -0
- package/models/components/voicegroupcreaterequest.d.ts.map +1 -0
- package/models/components/voicegroupcreaterequest.js +87 -0
- package/models/components/voicegroupcreaterequest.js.map +1 -0
- package/models/components/voicegroupproperties.d.ts +43 -0
- package/models/components/voicegroupproperties.d.ts.map +1 -0
- package/models/components/voicegroupproperties.js +66 -0
- package/models/components/voicegroupproperties.js.map +1 -0
- package/models/components/voicegroupresponse.d.ts +82 -0
- package/models/components/voicegroupresponse.d.ts.map +1 -0
- package/models/components/voicegroupresponse.js +108 -0
- package/models/components/voicegroupresponse.js.map +1 -0
- package/models/components/voicegroupupdaterequest.d.ts +61 -0
- package/models/components/voicegroupupdaterequest.d.ts.map +1 -0
- package/models/components/voicegroupupdaterequest.js +93 -0
- package/models/components/voicegroupupdaterequest.js.map +1 -0
- package/models/operations/index.d.ts +3 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/voicegroupsdelete.d.ts +31 -0
- package/models/operations/voicegroupsdelete.d.ts.map +1 -0
- package/models/operations/voicegroupsdelete.js +80 -0
- package/models/operations/voicegroupsdelete.js.map +1 -0
- package/models/operations/voicegroupsgetbyid.d.ts +29 -0
- package/models/operations/voicegroupsgetbyid.d.ts.map +1 -0
- package/models/operations/voicegroupsgetbyid.js +78 -0
- package/models/operations/voicegroupsgetbyid.js.map +1 -0
- package/models/operations/voicegroupslist.d.ts +73 -0
- package/models/operations/voicegroupslist.d.ts.map +1 -0
- package/models/operations/voicegroupslist.js +113 -0
- package/models/operations/voicegroupslist.js.map +1 -0
- package/openapi.json +1464 -511
- package/package.json +1 -1
- package/sdk/languagegroups.d.ts +19 -7
- package/sdk/languagegroups.d.ts.map +1 -1
- package/sdk/languagegroups.js +18 -6
- package/sdk/languagegroups.js.map +1 -1
- package/sdk/sdk.d.ts +3 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/voicegroups.d.ts +48 -0
- package/sdk/voicegroups.d.ts.map +1 -0
- package/sdk/voicegroups.js +72 -0
- package/sdk/voicegroups.js.map +1 -0
- package/src/funcs/languageGroupsCreate.ts +3 -1
- package/src/funcs/languageGroupsDelete.ts +3 -1
- package/src/funcs/languageGroupsGetById.ts +3 -1
- package/src/funcs/languageGroupsLanguageGroupsCreateVoiceSample.ts +7 -4
- package/src/funcs/languageGroupsList.ts +3 -1
- package/src/funcs/languageGroupsUpdate.ts +3 -1
- package/src/funcs/voiceGroupsCreate.ts +169 -0
- package/src/funcs/voiceGroupsDelete.ts +181 -0
- package/src/funcs/voiceGroupsGetById.ts +176 -0
- package/src/funcs/voiceGroupsList.ts +182 -0
- package/src/funcs/voiceGroupsUpdate.ts +169 -0
- package/src/funcs/voiceGroupsVoiceGroupsCreateVoiceSample.ts +170 -0
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +13 -1
- package/src/mcp-server/tools/languageGroupsCreate.ts +1 -1
- package/src/mcp-server/tools/languageGroupsDelete.ts +1 -1
- package/src/mcp-server/tools/languageGroupsGetById.ts +1 -1
- package/src/mcp-server/tools/languageGroupsLanguageGroupsCreateVoiceSample.ts +2 -2
- package/src/mcp-server/tools/languageGroupsList.ts +1 -1
- package/src/mcp-server/tools/languageGroupsUpdate.ts +1 -1
- package/src/mcp-server/tools/voiceGroupsCreate.ts +37 -0
- package/src/mcp-server/tools/voiceGroupsDelete.ts +37 -0
- package/src/mcp-server/tools/voiceGroupsGetById.ts +37 -0
- package/src/mcp-server/tools/voiceGroupsList.ts +37 -0
- package/src/mcp-server/tools/voiceGroupsUpdate.ts +37 -0
- package/src/mcp-server/tools/voiceGroupsVoiceGroupsCreateVoiceSample.ts +39 -0
- package/src/models/components/channelservices.ts +1 -0
- package/src/models/components/index.ts +6 -0
- package/src/models/components/languagegroupcreaterequest.ts +1 -1
- package/src/models/components/languagegroupproperties.ts +2 -2
- package/src/models/components/languagegroupresponse.ts +3 -3
- package/src/models/components/languagegroupupdaterequest.ts +1 -1
- package/src/models/components/languagesamplecreaterequest.ts +150 -0
- package/src/models/components/listresponsevoicegroupresponse.ts +118 -0
- package/src/models/components/organizationchannelconfig.ts +9 -0
- package/src/models/components/voicegroupcreaterequest.ts +110 -0
- package/src/models/components/voicegroupproperties.ts +42 -0
- package/src/models/components/voicegroupresponse.ts +166 -0
- package/src/models/components/voicegroupupdaterequest.ts +126 -0
- package/src/models/operations/index.ts +3 -0
- package/src/models/operations/voicegroupsdelete.ts +79 -0
- package/src/models/operations/voicegroupsgetbyid.ts +75 -0
- package/src/models/operations/voicegroupslist.ts +153 -0
- package/src/sdk/languagegroups.ts +19 -7
- package/src/sdk/sdk.ts +6 -0
- package/src/sdk/voicegroups.ts +118 -0
package/openapi.json
CHANGED
|
@@ -10755,8 +10755,9 @@
|
|
|
10755
10755
|
"language_groups"
|
|
10756
10756
|
],
|
|
10757
10757
|
"summary": "List Language Groups",
|
|
10758
|
-
"description": "
|
|
10758
|
+
"description": "Deprecated alias for `GET /api/v1/voice_groups/`.",
|
|
10759
10759
|
"operationId": "language_groups_list",
|
|
10760
|
+
"deprecated": true,
|
|
10760
10761
|
"security": [
|
|
10761
10762
|
{
|
|
10762
10763
|
"APIKeyHeader": []
|
|
@@ -10970,8 +10971,9 @@
|
|
|
10970
10971
|
"language_groups"
|
|
10971
10972
|
],
|
|
10972
10973
|
"summary": "Create Language Group",
|
|
10973
|
-
"description": "
|
|
10974
|
+
"description": "Deprecated alias for `POST /api/v1/voice_groups/`.",
|
|
10974
10975
|
"operationId": "language_groups_create",
|
|
10976
|
+
"deprecated": true,
|
|
10975
10977
|
"security": [
|
|
10976
10978
|
{
|
|
10977
10979
|
"APIKeyHeader": []
|
|
@@ -11015,8 +11017,9 @@
|
|
|
11015
11017
|
"language_groups"
|
|
11016
11018
|
],
|
|
11017
11019
|
"summary": "Update Language Group",
|
|
11018
|
-
"description": "
|
|
11020
|
+
"description": "Deprecated alias for `PUT /api/v1/voice_groups/`.",
|
|
11019
11021
|
"operationId": "language_groups_update",
|
|
11022
|
+
"deprecated": true,
|
|
11020
11023
|
"security": [
|
|
11021
11024
|
{
|
|
11022
11025
|
"APIKeyHeader": []
|
|
@@ -11062,8 +11065,9 @@
|
|
|
11062
11065
|
"language_groups"
|
|
11063
11066
|
],
|
|
11064
11067
|
"summary": "Get Language Group",
|
|
11065
|
-
"description": "
|
|
11068
|
+
"description": "Deprecated alias for `GET /api/v1/voice_groups/{voice_group_id}`.",
|
|
11066
11069
|
"operationId": "language_groups_get_by_id",
|
|
11070
|
+
"deprecated": true,
|
|
11067
11071
|
"security": [
|
|
11068
11072
|
{
|
|
11069
11073
|
"APIKeyHeader": []
|
|
@@ -11108,8 +11112,9 @@
|
|
|
11108
11112
|
"language_groups"
|
|
11109
11113
|
],
|
|
11110
11114
|
"summary": "Delete Language Group",
|
|
11111
|
-
"description": "
|
|
11115
|
+
"description": "Deprecated alias for `DELETE /api/v1/voice_groups/{voice_group_id}`.",
|
|
11112
11116
|
"operationId": "language_groups_delete",
|
|
11117
|
+
"deprecated": true,
|
|
11113
11118
|
"security": [
|
|
11114
11119
|
{
|
|
11115
11120
|
"APIKeyHeader": []
|
|
@@ -11163,13 +11168,13 @@
|
|
|
11163
11168
|
"language_groups"
|
|
11164
11169
|
],
|
|
11165
11170
|
"summary": "Create Voice Sample",
|
|
11166
|
-
"description": "
|
|
11171
|
+
"description": "Deprecated alias for `POST /api/v1/voice_groups/voices/sample`.",
|
|
11167
11172
|
"operationId": "language_groups_create_voice_sample",
|
|
11168
11173
|
"requestBody": {
|
|
11169
11174
|
"content": {
|
|
11170
11175
|
"application/json": {
|
|
11171
11176
|
"schema": {
|
|
11172
|
-
"$ref": "#/components/schemas/
|
|
11177
|
+
"$ref": "#/components/schemas/LanguageSampleCreateRequest"
|
|
11173
11178
|
}
|
|
11174
11179
|
}
|
|
11175
11180
|
},
|
|
@@ -11199,6 +11204,7 @@
|
|
|
11199
11204
|
}
|
|
11200
11205
|
}
|
|
11201
11206
|
},
|
|
11207
|
+
"deprecated": true,
|
|
11202
11208
|
"security": [
|
|
11203
11209
|
{
|
|
11204
11210
|
"APIKeyHeader": []
|
|
@@ -11206,146 +11212,14 @@
|
|
|
11206
11212
|
]
|
|
11207
11213
|
}
|
|
11208
11214
|
},
|
|
11209
|
-
"/api/v1/
|
|
11210
|
-
"post": {
|
|
11211
|
-
"tags": [
|
|
11212
|
-
"takeouts"
|
|
11213
|
-
],
|
|
11214
|
-
"summary": "Create Takeout",
|
|
11215
|
-
"operationId": "takeouts_create",
|
|
11216
|
-
"responses": {
|
|
11217
|
-
"200": {
|
|
11218
|
-
"description": "Successful Response",
|
|
11219
|
-
"content": {
|
|
11220
|
-
"application/json": {
|
|
11221
|
-
"schema": {
|
|
11222
|
-
"$ref": "#/components/schemas/CreateTakeoutResponse"
|
|
11223
|
-
}
|
|
11224
|
-
}
|
|
11225
|
-
}
|
|
11226
|
-
}
|
|
11227
|
-
},
|
|
11228
|
-
"security": [
|
|
11229
|
-
{
|
|
11230
|
-
"APIKeyHeader": []
|
|
11231
|
-
}
|
|
11232
|
-
]
|
|
11233
|
-
}
|
|
11234
|
-
},
|
|
11235
|
-
"/api/v1/takeouts/get/{job_id}": {
|
|
11236
|
-
"get": {
|
|
11237
|
-
"tags": [
|
|
11238
|
-
"takeouts"
|
|
11239
|
-
],
|
|
11240
|
-
"summary": "Get Takeout",
|
|
11241
|
-
"operationId": "takeouts_get_by_job_id",
|
|
11242
|
-
"security": [
|
|
11243
|
-
{
|
|
11244
|
-
"APIKeyHeader": []
|
|
11245
|
-
}
|
|
11246
|
-
],
|
|
11247
|
-
"parameters": [
|
|
11248
|
-
{
|
|
11249
|
-
"name": "job_id",
|
|
11250
|
-
"in": "path",
|
|
11251
|
-
"required": true,
|
|
11252
|
-
"schema": {
|
|
11253
|
-
"type": "string",
|
|
11254
|
-
"title": "Job Id"
|
|
11255
|
-
}
|
|
11256
|
-
}
|
|
11257
|
-
],
|
|
11258
|
-
"responses": {
|
|
11259
|
-
"200": {
|
|
11260
|
-
"description": "Successful Response",
|
|
11261
|
-
"content": {
|
|
11262
|
-
"application/json": {
|
|
11263
|
-
"schema": {
|
|
11264
|
-
"$ref": "#/components/schemas/TakeoutStatusResponse"
|
|
11265
|
-
}
|
|
11266
|
-
}
|
|
11267
|
-
}
|
|
11268
|
-
},
|
|
11269
|
-
"422": {
|
|
11270
|
-
"description": "Validation Error",
|
|
11271
|
-
"content": {
|
|
11272
|
-
"application/json": {
|
|
11273
|
-
"schema": {
|
|
11274
|
-
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11275
|
-
}
|
|
11276
|
-
}
|
|
11277
|
-
}
|
|
11278
|
-
}
|
|
11279
|
-
}
|
|
11280
|
-
}
|
|
11281
|
-
},
|
|
11282
|
-
"/api/v1/takeouts/get/{job_id}/file/{file_name}": {
|
|
11283
|
-
"get": {
|
|
11284
|
-
"tags": [
|
|
11285
|
-
"takeouts"
|
|
11286
|
-
],
|
|
11287
|
-
"summary": "Get File",
|
|
11288
|
-
"operationId": "takeouts_get_file",
|
|
11289
|
-
"security": [
|
|
11290
|
-
{
|
|
11291
|
-
"APIKeyHeader": []
|
|
11292
|
-
}
|
|
11293
|
-
],
|
|
11294
|
-
"parameters": [
|
|
11295
|
-
{
|
|
11296
|
-
"name": "job_id",
|
|
11297
|
-
"in": "path",
|
|
11298
|
-
"required": true,
|
|
11299
|
-
"schema": {
|
|
11300
|
-
"type": "string",
|
|
11301
|
-
"title": "Job Id"
|
|
11302
|
-
}
|
|
11303
|
-
},
|
|
11304
|
-
{
|
|
11305
|
-
"name": "file_name",
|
|
11306
|
-
"in": "path",
|
|
11307
|
-
"required": true,
|
|
11308
|
-
"schema": {
|
|
11309
|
-
"type": "string",
|
|
11310
|
-
"title": "File Name"
|
|
11311
|
-
}
|
|
11312
|
-
}
|
|
11313
|
-
],
|
|
11314
|
-
"responses": {
|
|
11315
|
-
"200": {
|
|
11316
|
-
"description": "File content",
|
|
11317
|
-
"content": {
|
|
11318
|
-
"application/zip": {
|
|
11319
|
-
"schema": {
|
|
11320
|
-
"type": "string",
|
|
11321
|
-
"title": "bytes",
|
|
11322
|
-
"format": "binary"
|
|
11323
|
-
}
|
|
11324
|
-
}
|
|
11325
|
-
}
|
|
11326
|
-
},
|
|
11327
|
-
"422": {
|
|
11328
|
-
"description": "Validation Error",
|
|
11329
|
-
"content": {
|
|
11330
|
-
"application/json": {
|
|
11331
|
-
"schema": {
|
|
11332
|
-
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11333
|
-
}
|
|
11334
|
-
}
|
|
11335
|
-
}
|
|
11336
|
-
}
|
|
11337
|
-
}
|
|
11338
|
-
}
|
|
11339
|
-
},
|
|
11340
|
-
"/api/v1/users/": {
|
|
11215
|
+
"/api/v1/voice_groups/": {
|
|
11341
11216
|
"get": {
|
|
11342
11217
|
"tags": [
|
|
11343
|
-
"
|
|
11344
|
-
"V1"
|
|
11218
|
+
"voice_groups"
|
|
11345
11219
|
],
|
|
11346
|
-
"summary": "List
|
|
11347
|
-
"description": "
|
|
11348
|
-
"operationId": "
|
|
11220
|
+
"summary": "List Voice Groups",
|
|
11221
|
+
"description": "Fetch voice groups.",
|
|
11222
|
+
"operationId": "voice_groups_list",
|
|
11349
11223
|
"security": [
|
|
11350
11224
|
{
|
|
11351
11225
|
"APIKeyHeader": []
|
|
@@ -11398,7 +11272,7 @@
|
|
|
11398
11272
|
"schema": {
|
|
11399
11273
|
"type": "array",
|
|
11400
11274
|
"items": {
|
|
11401
|
-
"$ref": "#/components/schemas/
|
|
11275
|
+
"$ref": "#/components/schemas/VoiceGroupProperties"
|
|
11402
11276
|
},
|
|
11403
11277
|
"description": "String names of fields to search. Correspond by index to search field values",
|
|
11404
11278
|
"examples": [
|
|
@@ -11434,7 +11308,7 @@
|
|
|
11434
11308
|
"schema": {
|
|
11435
11309
|
"anyOf": [
|
|
11436
11310
|
{
|
|
11437
|
-
"$ref": "#/components/schemas/
|
|
11311
|
+
"$ref": "#/components/schemas/VoiceGroupProperties"
|
|
11438
11312
|
},
|
|
11439
11313
|
{
|
|
11440
11314
|
"type": "null"
|
|
@@ -11475,7 +11349,7 @@
|
|
|
11475
11349
|
{
|
|
11476
11350
|
"type": "array",
|
|
11477
11351
|
"items": {
|
|
11478
|
-
"$ref": "#/components/schemas/
|
|
11352
|
+
"$ref": "#/components/schemas/VoiceGroupProperties"
|
|
11479
11353
|
}
|
|
11480
11354
|
},
|
|
11481
11355
|
{
|
|
@@ -11537,7 +11411,7 @@
|
|
|
11537
11411
|
"content": {
|
|
11538
11412
|
"application/json": {
|
|
11539
11413
|
"schema": {
|
|
11540
|
-
"$ref": "#/components/schemas/
|
|
11414
|
+
"$ref": "#/components/schemas/ListResponse_VoiceGroupResponse_"
|
|
11541
11415
|
}
|
|
11542
11416
|
}
|
|
11543
11417
|
}
|
|
@@ -11556,12 +11430,11 @@
|
|
|
11556
11430
|
},
|
|
11557
11431
|
"post": {
|
|
11558
11432
|
"tags": [
|
|
11559
|
-
"
|
|
11560
|
-
"V1"
|
|
11433
|
+
"voice_groups"
|
|
11561
11434
|
],
|
|
11562
|
-
"summary": "Create
|
|
11563
|
-
"description": "Create a new
|
|
11564
|
-
"operationId": "
|
|
11435
|
+
"summary": "Create Voice Group",
|
|
11436
|
+
"description": "Create a new voice group.",
|
|
11437
|
+
"operationId": "voice_groups_create",
|
|
11565
11438
|
"security": [
|
|
11566
11439
|
{
|
|
11567
11440
|
"APIKeyHeader": []
|
|
@@ -11572,7 +11445,7 @@
|
|
|
11572
11445
|
"content": {
|
|
11573
11446
|
"application/json": {
|
|
11574
11447
|
"schema": {
|
|
11575
|
-
"$ref": "#/components/schemas/
|
|
11448
|
+
"$ref": "#/components/schemas/VoiceGroupCreateRequest"
|
|
11576
11449
|
}
|
|
11577
11450
|
}
|
|
11578
11451
|
}
|
|
@@ -11583,7 +11456,7 @@
|
|
|
11583
11456
|
"content": {
|
|
11584
11457
|
"application/json": {
|
|
11585
11458
|
"schema": {
|
|
11586
|
-
"$ref": "#/components/schemas/
|
|
11459
|
+
"$ref": "#/components/schemas/VoiceGroupResponse"
|
|
11587
11460
|
}
|
|
11588
11461
|
}
|
|
11589
11462
|
}
|
|
@@ -11602,12 +11475,11 @@
|
|
|
11602
11475
|
},
|
|
11603
11476
|
"put": {
|
|
11604
11477
|
"tags": [
|
|
11605
|
-
"
|
|
11606
|
-
"V1"
|
|
11478
|
+
"voice_groups"
|
|
11607
11479
|
],
|
|
11608
|
-
"summary": "Update
|
|
11609
|
-
"description": "Update an existing
|
|
11610
|
-
"operationId": "
|
|
11480
|
+
"summary": "Update Voice Group",
|
|
11481
|
+
"description": "Update an existing voice group",
|
|
11482
|
+
"operationId": "voice_groups_update",
|
|
11611
11483
|
"security": [
|
|
11612
11484
|
{
|
|
11613
11485
|
"APIKeyHeader": []
|
|
@@ -11618,7 +11490,7 @@
|
|
|
11618
11490
|
"content": {
|
|
11619
11491
|
"application/json": {
|
|
11620
11492
|
"schema": {
|
|
11621
|
-
"$ref": "#/components/schemas/
|
|
11493
|
+
"$ref": "#/components/schemas/VoiceGroupUpdateRequest"
|
|
11622
11494
|
}
|
|
11623
11495
|
}
|
|
11624
11496
|
}
|
|
@@ -11629,54 +11501,10 @@
|
|
|
11629
11501
|
"content": {
|
|
11630
11502
|
"application/json": {
|
|
11631
11503
|
"schema": {
|
|
11632
|
-
"$ref": "#/components/schemas/
|
|
11633
|
-
}
|
|
11634
|
-
}
|
|
11635
|
-
}
|
|
11636
|
-
},
|
|
11637
|
-
"422": {
|
|
11638
|
-
"description": "Validation Error",
|
|
11639
|
-
"content": {
|
|
11640
|
-
"application/json": {
|
|
11641
|
-
"schema": {
|
|
11642
|
-
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11504
|
+
"$ref": "#/components/schemas/VoiceGroupResponse"
|
|
11643
11505
|
}
|
|
11644
11506
|
}
|
|
11645
11507
|
}
|
|
11646
|
-
}
|
|
11647
|
-
}
|
|
11648
|
-
},
|
|
11649
|
-
"delete": {
|
|
11650
|
-
"tags": [
|
|
11651
|
-
"users",
|
|
11652
|
-
"V1"
|
|
11653
|
-
],
|
|
11654
|
-
"summary": "Delete User",
|
|
11655
|
-
"description": "Delete a user.",
|
|
11656
|
-
"operationId": "users_delete",
|
|
11657
|
-
"security": [
|
|
11658
|
-
{
|
|
11659
|
-
"APIKeyHeader": []
|
|
11660
|
-
}
|
|
11661
|
-
],
|
|
11662
|
-
"requestBody": {
|
|
11663
|
-
"required": true,
|
|
11664
|
-
"content": {
|
|
11665
|
-
"application/json": {
|
|
11666
|
-
"schema": {
|
|
11667
|
-
"$ref": "#/components/schemas/UserDeleteRequest"
|
|
11668
|
-
}
|
|
11669
|
-
}
|
|
11670
|
-
}
|
|
11671
|
-
},
|
|
11672
|
-
"responses": {
|
|
11673
|
-
"200": {
|
|
11674
|
-
"description": "Successful Response",
|
|
11675
|
-
"content": {
|
|
11676
|
-
"application/json": {
|
|
11677
|
-
"schema": {}
|
|
11678
|
-
}
|
|
11679
|
-
}
|
|
11680
11508
|
},
|
|
11681
11509
|
"422": {
|
|
11682
11510
|
"description": "Validation Error",
|
|
@@ -11691,15 +11519,14 @@
|
|
|
11691
11519
|
}
|
|
11692
11520
|
}
|
|
11693
11521
|
},
|
|
11694
|
-
"/api/v1/
|
|
11522
|
+
"/api/v1/voice_groups/{voice_group_id}": {
|
|
11695
11523
|
"get": {
|
|
11696
11524
|
"tags": [
|
|
11697
|
-
"
|
|
11698
|
-
"V1"
|
|
11525
|
+
"voice_groups"
|
|
11699
11526
|
],
|
|
11700
|
-
"summary": "Get
|
|
11701
|
-
"description": "Fetch a given
|
|
11702
|
-
"operationId": "
|
|
11527
|
+
"summary": "Get Voice Group",
|
|
11528
|
+
"description": "Fetch a given voice group.",
|
|
11529
|
+
"operationId": "voice_groups_get_by_id",
|
|
11703
11530
|
"security": [
|
|
11704
11531
|
{
|
|
11705
11532
|
"APIKeyHeader": []
|
|
@@ -11707,12 +11534,12 @@
|
|
|
11707
11534
|
],
|
|
11708
11535
|
"parameters": [
|
|
11709
11536
|
{
|
|
11710
|
-
"name": "
|
|
11537
|
+
"name": "voice_group_id",
|
|
11711
11538
|
"in": "path",
|
|
11712
11539
|
"required": true,
|
|
11713
11540
|
"schema": {
|
|
11714
|
-
"type": "
|
|
11715
|
-
"title": "
|
|
11541
|
+
"type": "integer",
|
|
11542
|
+
"title": "Voice Group Id"
|
|
11716
11543
|
}
|
|
11717
11544
|
}
|
|
11718
11545
|
],
|
|
@@ -11722,7 +11549,7 @@
|
|
|
11722
11549
|
"content": {
|
|
11723
11550
|
"application/json": {
|
|
11724
11551
|
"schema": {
|
|
11725
|
-
"$ref": "#/components/schemas/
|
|
11552
|
+
"$ref": "#/components/schemas/VoiceGroupResponse"
|
|
11726
11553
|
}
|
|
11727
11554
|
}
|
|
11728
11555
|
}
|
|
@@ -11738,17 +11565,14 @@
|
|
|
11738
11565
|
}
|
|
11739
11566
|
}
|
|
11740
11567
|
}
|
|
11741
|
-
}
|
|
11742
|
-
|
|
11743
|
-
"/api/v1/users/{user_email}/send_email": {
|
|
11744
|
-
"post": {
|
|
11568
|
+
},
|
|
11569
|
+
"delete": {
|
|
11745
11570
|
"tags": [
|
|
11746
|
-
"
|
|
11747
|
-
"V1"
|
|
11571
|
+
"voice_groups"
|
|
11748
11572
|
],
|
|
11749
|
-
"summary": "
|
|
11750
|
-
"description": "
|
|
11751
|
-
"operationId": "
|
|
11573
|
+
"summary": "Delete Voice Group",
|
|
11574
|
+
"description": "Delete a voice group.",
|
|
11575
|
+
"operationId": "voice_groups_delete",
|
|
11752
11576
|
"security": [
|
|
11753
11577
|
{
|
|
11754
11578
|
"APIKeyHeader": []
|
|
@@ -11756,22 +11580,21 @@
|
|
|
11756
11580
|
],
|
|
11757
11581
|
"parameters": [
|
|
11758
11582
|
{
|
|
11759
|
-
"name": "
|
|
11583
|
+
"name": "voice_group_id",
|
|
11760
11584
|
"in": "path",
|
|
11761
11585
|
"required": true,
|
|
11762
11586
|
"schema": {
|
|
11763
|
-
"type": "
|
|
11764
|
-
"title": "
|
|
11587
|
+
"type": "integer",
|
|
11588
|
+
"title": "Voice Group Id"
|
|
11765
11589
|
}
|
|
11766
11590
|
},
|
|
11767
11591
|
{
|
|
11768
|
-
"name": "
|
|
11592
|
+
"name": "reason",
|
|
11769
11593
|
"in": "query",
|
|
11770
|
-
"required":
|
|
11594
|
+
"required": true,
|
|
11771
11595
|
"schema": {
|
|
11772
|
-
"type": "
|
|
11773
|
-
"
|
|
11774
|
-
"title": "Skip Auth"
|
|
11596
|
+
"type": "string",
|
|
11597
|
+
"title": "Reason"
|
|
11775
11598
|
}
|
|
11776
11599
|
}
|
|
11777
11600
|
],
|
|
@@ -11797,21 +11620,661 @@
|
|
|
11797
11620
|
}
|
|
11798
11621
|
}
|
|
11799
11622
|
},
|
|
11800
|
-
"/api/v1/
|
|
11801
|
-
"
|
|
11623
|
+
"/api/v1/voice_groups/voices/sample": {
|
|
11624
|
+
"post": {
|
|
11802
11625
|
"tags": [
|
|
11803
|
-
"
|
|
11804
|
-
"V1"
|
|
11626
|
+
"voice_groups"
|
|
11805
11627
|
],
|
|
11806
|
-
"summary": "
|
|
11807
|
-
"description": "
|
|
11808
|
-
"operationId": "
|
|
11809
|
-
"
|
|
11810
|
-
"
|
|
11811
|
-
"
|
|
11812
|
-
|
|
11813
|
-
|
|
11814
|
-
|
|
11628
|
+
"summary": "Create Voice Sample",
|
|
11629
|
+
"description": "Generate voice sample.",
|
|
11630
|
+
"operationId": "voice_groups_create_voice_sample",
|
|
11631
|
+
"requestBody": {
|
|
11632
|
+
"content": {
|
|
11633
|
+
"application/json": {
|
|
11634
|
+
"schema": {
|
|
11635
|
+
"$ref": "#/components/schemas/VoiceSampleCreateRequest"
|
|
11636
|
+
}
|
|
11637
|
+
}
|
|
11638
|
+
},
|
|
11639
|
+
"required": true
|
|
11640
|
+
},
|
|
11641
|
+
"responses": {
|
|
11642
|
+
"200": {
|
|
11643
|
+
"description": "Successful Response",
|
|
11644
|
+
"content": {
|
|
11645
|
+
"application/octet-stream": {
|
|
11646
|
+
"schema": {
|
|
11647
|
+
"type": "string",
|
|
11648
|
+
"format": "binary",
|
|
11649
|
+
"title": "bytes"
|
|
11650
|
+
}
|
|
11651
|
+
}
|
|
11652
|
+
}
|
|
11653
|
+
},
|
|
11654
|
+
"422": {
|
|
11655
|
+
"description": "Validation Error",
|
|
11656
|
+
"content": {
|
|
11657
|
+
"application/json": {
|
|
11658
|
+
"schema": {
|
|
11659
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11660
|
+
}
|
|
11661
|
+
}
|
|
11662
|
+
}
|
|
11663
|
+
}
|
|
11664
|
+
},
|
|
11665
|
+
"security": [
|
|
11666
|
+
{
|
|
11667
|
+
"APIKeyHeader": []
|
|
11668
|
+
}
|
|
11669
|
+
]
|
|
11670
|
+
}
|
|
11671
|
+
},
|
|
11672
|
+
"/api/v1/takeouts/create": {
|
|
11673
|
+
"post": {
|
|
11674
|
+
"tags": [
|
|
11675
|
+
"takeouts"
|
|
11676
|
+
],
|
|
11677
|
+
"summary": "Create Takeout",
|
|
11678
|
+
"operationId": "takeouts_create",
|
|
11679
|
+
"responses": {
|
|
11680
|
+
"200": {
|
|
11681
|
+
"description": "Successful Response",
|
|
11682
|
+
"content": {
|
|
11683
|
+
"application/json": {
|
|
11684
|
+
"schema": {
|
|
11685
|
+
"$ref": "#/components/schemas/CreateTakeoutResponse"
|
|
11686
|
+
}
|
|
11687
|
+
}
|
|
11688
|
+
}
|
|
11689
|
+
}
|
|
11690
|
+
},
|
|
11691
|
+
"security": [
|
|
11692
|
+
{
|
|
11693
|
+
"APIKeyHeader": []
|
|
11694
|
+
}
|
|
11695
|
+
]
|
|
11696
|
+
}
|
|
11697
|
+
},
|
|
11698
|
+
"/api/v1/takeouts/get/{job_id}": {
|
|
11699
|
+
"get": {
|
|
11700
|
+
"tags": [
|
|
11701
|
+
"takeouts"
|
|
11702
|
+
],
|
|
11703
|
+
"summary": "Get Takeout",
|
|
11704
|
+
"operationId": "takeouts_get_by_job_id",
|
|
11705
|
+
"security": [
|
|
11706
|
+
{
|
|
11707
|
+
"APIKeyHeader": []
|
|
11708
|
+
}
|
|
11709
|
+
],
|
|
11710
|
+
"parameters": [
|
|
11711
|
+
{
|
|
11712
|
+
"name": "job_id",
|
|
11713
|
+
"in": "path",
|
|
11714
|
+
"required": true,
|
|
11715
|
+
"schema": {
|
|
11716
|
+
"type": "string",
|
|
11717
|
+
"title": "Job Id"
|
|
11718
|
+
}
|
|
11719
|
+
}
|
|
11720
|
+
],
|
|
11721
|
+
"responses": {
|
|
11722
|
+
"200": {
|
|
11723
|
+
"description": "Successful Response",
|
|
11724
|
+
"content": {
|
|
11725
|
+
"application/json": {
|
|
11726
|
+
"schema": {
|
|
11727
|
+
"$ref": "#/components/schemas/TakeoutStatusResponse"
|
|
11728
|
+
}
|
|
11729
|
+
}
|
|
11730
|
+
}
|
|
11731
|
+
},
|
|
11732
|
+
"422": {
|
|
11733
|
+
"description": "Validation Error",
|
|
11734
|
+
"content": {
|
|
11735
|
+
"application/json": {
|
|
11736
|
+
"schema": {
|
|
11737
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11738
|
+
}
|
|
11739
|
+
}
|
|
11740
|
+
}
|
|
11741
|
+
}
|
|
11742
|
+
}
|
|
11743
|
+
}
|
|
11744
|
+
},
|
|
11745
|
+
"/api/v1/takeouts/get/{job_id}/file/{file_name}": {
|
|
11746
|
+
"get": {
|
|
11747
|
+
"tags": [
|
|
11748
|
+
"takeouts"
|
|
11749
|
+
],
|
|
11750
|
+
"summary": "Get File",
|
|
11751
|
+
"operationId": "takeouts_get_file",
|
|
11752
|
+
"security": [
|
|
11753
|
+
{
|
|
11754
|
+
"APIKeyHeader": []
|
|
11755
|
+
}
|
|
11756
|
+
],
|
|
11757
|
+
"parameters": [
|
|
11758
|
+
{
|
|
11759
|
+
"name": "job_id",
|
|
11760
|
+
"in": "path",
|
|
11761
|
+
"required": true,
|
|
11762
|
+
"schema": {
|
|
11763
|
+
"type": "string",
|
|
11764
|
+
"title": "Job Id"
|
|
11765
|
+
}
|
|
11766
|
+
},
|
|
11767
|
+
{
|
|
11768
|
+
"name": "file_name",
|
|
11769
|
+
"in": "path",
|
|
11770
|
+
"required": true,
|
|
11771
|
+
"schema": {
|
|
11772
|
+
"type": "string",
|
|
11773
|
+
"title": "File Name"
|
|
11774
|
+
}
|
|
11775
|
+
}
|
|
11776
|
+
],
|
|
11777
|
+
"responses": {
|
|
11778
|
+
"200": {
|
|
11779
|
+
"description": "File content",
|
|
11780
|
+
"content": {
|
|
11781
|
+
"application/zip": {
|
|
11782
|
+
"schema": {
|
|
11783
|
+
"type": "string",
|
|
11784
|
+
"title": "bytes",
|
|
11785
|
+
"format": "binary"
|
|
11786
|
+
}
|
|
11787
|
+
}
|
|
11788
|
+
}
|
|
11789
|
+
},
|
|
11790
|
+
"422": {
|
|
11791
|
+
"description": "Validation Error",
|
|
11792
|
+
"content": {
|
|
11793
|
+
"application/json": {
|
|
11794
|
+
"schema": {
|
|
11795
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
11796
|
+
}
|
|
11797
|
+
}
|
|
11798
|
+
}
|
|
11799
|
+
}
|
|
11800
|
+
}
|
|
11801
|
+
}
|
|
11802
|
+
},
|
|
11803
|
+
"/api/v1/users/": {
|
|
11804
|
+
"get": {
|
|
11805
|
+
"tags": [
|
|
11806
|
+
"users",
|
|
11807
|
+
"V1"
|
|
11808
|
+
],
|
|
11809
|
+
"summary": "List Users",
|
|
11810
|
+
"description": "List the existing users.",
|
|
11811
|
+
"operationId": "users_list",
|
|
11812
|
+
"security": [
|
|
11813
|
+
{
|
|
11814
|
+
"APIKeyHeader": []
|
|
11815
|
+
}
|
|
11816
|
+
],
|
|
11817
|
+
"parameters": [
|
|
11818
|
+
{
|
|
11819
|
+
"name": "page",
|
|
11820
|
+
"in": "query",
|
|
11821
|
+
"required": false,
|
|
11822
|
+
"schema": {
|
|
11823
|
+
"anyOf": [
|
|
11824
|
+
{
|
|
11825
|
+
"type": "integer",
|
|
11826
|
+
"minimum": 0
|
|
11827
|
+
},
|
|
11828
|
+
{
|
|
11829
|
+
"type": "null"
|
|
11830
|
+
}
|
|
11831
|
+
],
|
|
11832
|
+
"description": "The page number from which to start (0-based)",
|
|
11833
|
+
"examples": [
|
|
11834
|
+
0
|
|
11835
|
+
],
|
|
11836
|
+
"default": 0,
|
|
11837
|
+
"title": "Page"
|
|
11838
|
+
},
|
|
11839
|
+
"description": "The page number from which to start (0-based)"
|
|
11840
|
+
},
|
|
11841
|
+
{
|
|
11842
|
+
"name": "limit",
|
|
11843
|
+
"in": "query",
|
|
11844
|
+
"required": false,
|
|
11845
|
+
"schema": {
|
|
11846
|
+
"type": "integer",
|
|
11847
|
+
"minimum": 0,
|
|
11848
|
+
"description": "The maximum number of items to return",
|
|
11849
|
+
"examples": [
|
|
11850
|
+
25
|
|
11851
|
+
],
|
|
11852
|
+
"default": 25,
|
|
11853
|
+
"title": "Limit"
|
|
11854
|
+
},
|
|
11855
|
+
"description": "The maximum number of items to return"
|
|
11856
|
+
},
|
|
11857
|
+
{
|
|
11858
|
+
"name": "search_fields",
|
|
11859
|
+
"in": "query",
|
|
11860
|
+
"required": false,
|
|
11861
|
+
"schema": {
|
|
11862
|
+
"type": "array",
|
|
11863
|
+
"items": {
|
|
11864
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
11865
|
+
},
|
|
11866
|
+
"description": "String names of fields to search. Correspond by index to search field values",
|
|
11867
|
+
"examples": [
|
|
11868
|
+
"name"
|
|
11869
|
+
],
|
|
11870
|
+
"default": [],
|
|
11871
|
+
"title": "Search Fields"
|
|
11872
|
+
},
|
|
11873
|
+
"description": "String names of fields to search. Correspond by index to search field values"
|
|
11874
|
+
},
|
|
11875
|
+
{
|
|
11876
|
+
"name": "search_field_values",
|
|
11877
|
+
"in": "query",
|
|
11878
|
+
"required": false,
|
|
11879
|
+
"schema": {
|
|
11880
|
+
"type": "array",
|
|
11881
|
+
"items": {
|
|
11882
|
+
"type": "string"
|
|
11883
|
+
},
|
|
11884
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list",
|
|
11885
|
+
"examples": [
|
|
11886
|
+
"Some Object Name"
|
|
11887
|
+
],
|
|
11888
|
+
"default": [],
|
|
11889
|
+
"title": "Search Field Values"
|
|
11890
|
+
},
|
|
11891
|
+
"description": "Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"
|
|
11892
|
+
},
|
|
11893
|
+
{
|
|
11894
|
+
"name": "order_by",
|
|
11895
|
+
"in": "query",
|
|
11896
|
+
"required": false,
|
|
11897
|
+
"schema": {
|
|
11898
|
+
"anyOf": [
|
|
11899
|
+
{
|
|
11900
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
11901
|
+
},
|
|
11902
|
+
{
|
|
11903
|
+
"type": "null"
|
|
11904
|
+
}
|
|
11905
|
+
],
|
|
11906
|
+
"description": "The field whose value should be used to order the results",
|
|
11907
|
+
"examples": [
|
|
11908
|
+
"name"
|
|
11909
|
+
],
|
|
11910
|
+
"title": "Order By"
|
|
11911
|
+
},
|
|
11912
|
+
"description": "The field whose value should be used to order the results"
|
|
11913
|
+
},
|
|
11914
|
+
{
|
|
11915
|
+
"name": "order_by_direction",
|
|
11916
|
+
"in": "query",
|
|
11917
|
+
"required": false,
|
|
11918
|
+
"schema": {
|
|
11919
|
+
"anyOf": [
|
|
11920
|
+
{
|
|
11921
|
+
"$ref": "#/components/schemas/OrderByDirection"
|
|
11922
|
+
},
|
|
11923
|
+
{
|
|
11924
|
+
"type": "null"
|
|
11925
|
+
}
|
|
11926
|
+
],
|
|
11927
|
+
"description": "The direction in which to order the results",
|
|
11928
|
+
"title": "Order By Direction"
|
|
11929
|
+
},
|
|
11930
|
+
"description": "The direction in which to order the results"
|
|
11931
|
+
},
|
|
11932
|
+
{
|
|
11933
|
+
"name": "fields",
|
|
11934
|
+
"in": "query",
|
|
11935
|
+
"required": false,
|
|
11936
|
+
"schema": {
|
|
11937
|
+
"anyOf": [
|
|
11938
|
+
{
|
|
11939
|
+
"type": "array",
|
|
11940
|
+
"items": {
|
|
11941
|
+
"$ref": "#/components/schemas/UserProperties"
|
|
11942
|
+
}
|
|
11943
|
+
},
|
|
11944
|
+
{
|
|
11945
|
+
"type": "null"
|
|
11946
|
+
}
|
|
11947
|
+
],
|
|
11948
|
+
"description": "The fields to include in the response",
|
|
11949
|
+
"default": [],
|
|
11950
|
+
"title": "Fields"
|
|
11951
|
+
},
|
|
11952
|
+
"description": "The fields to include in the response"
|
|
11953
|
+
},
|
|
11954
|
+
{
|
|
11955
|
+
"name": "start_datetime",
|
|
11956
|
+
"in": "query",
|
|
11957
|
+
"required": false,
|
|
11958
|
+
"schema": {
|
|
11959
|
+
"anyOf": [
|
|
11960
|
+
{
|
|
11961
|
+
"type": "string"
|
|
11962
|
+
},
|
|
11963
|
+
{
|
|
11964
|
+
"type": "null"
|
|
11965
|
+
}
|
|
11966
|
+
],
|
|
11967
|
+
"description": "The start datetime for filtering results",
|
|
11968
|
+
"examples": [
|
|
11969
|
+
"2023-01-01T00:00:00Z"
|
|
11970
|
+
],
|
|
11971
|
+
"title": "Start Datetime"
|
|
11972
|
+
},
|
|
11973
|
+
"description": "The start datetime for filtering results"
|
|
11974
|
+
},
|
|
11975
|
+
{
|
|
11976
|
+
"name": "end_datetime",
|
|
11977
|
+
"in": "query",
|
|
11978
|
+
"required": false,
|
|
11979
|
+
"schema": {
|
|
11980
|
+
"anyOf": [
|
|
11981
|
+
{
|
|
11982
|
+
"type": "string"
|
|
11983
|
+
},
|
|
11984
|
+
{
|
|
11985
|
+
"type": "null"
|
|
11986
|
+
}
|
|
11987
|
+
],
|
|
11988
|
+
"description": "The end datetime for filtering results",
|
|
11989
|
+
"examples": [
|
|
11990
|
+
"2024-01-01T00:00:00Z"
|
|
11991
|
+
],
|
|
11992
|
+
"title": "End Datetime"
|
|
11993
|
+
},
|
|
11994
|
+
"description": "The end datetime for filtering results"
|
|
11995
|
+
}
|
|
11996
|
+
],
|
|
11997
|
+
"responses": {
|
|
11998
|
+
"200": {
|
|
11999
|
+
"description": "Successful Response",
|
|
12000
|
+
"content": {
|
|
12001
|
+
"application/json": {
|
|
12002
|
+
"schema": {
|
|
12003
|
+
"$ref": "#/components/schemas/ListResponse_UserResponse_"
|
|
12004
|
+
}
|
|
12005
|
+
}
|
|
12006
|
+
}
|
|
12007
|
+
},
|
|
12008
|
+
"422": {
|
|
12009
|
+
"description": "Validation Error",
|
|
12010
|
+
"content": {
|
|
12011
|
+
"application/json": {
|
|
12012
|
+
"schema": {
|
|
12013
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12014
|
+
}
|
|
12015
|
+
}
|
|
12016
|
+
}
|
|
12017
|
+
}
|
|
12018
|
+
}
|
|
12019
|
+
},
|
|
12020
|
+
"post": {
|
|
12021
|
+
"tags": [
|
|
12022
|
+
"users",
|
|
12023
|
+
"V1"
|
|
12024
|
+
],
|
|
12025
|
+
"summary": "Create User",
|
|
12026
|
+
"description": "Create a new user.",
|
|
12027
|
+
"operationId": "users_create",
|
|
12028
|
+
"security": [
|
|
12029
|
+
{
|
|
12030
|
+
"APIKeyHeader": []
|
|
12031
|
+
}
|
|
12032
|
+
],
|
|
12033
|
+
"requestBody": {
|
|
12034
|
+
"required": true,
|
|
12035
|
+
"content": {
|
|
12036
|
+
"application/json": {
|
|
12037
|
+
"schema": {
|
|
12038
|
+
"$ref": "#/components/schemas/UserCreateRequest"
|
|
12039
|
+
}
|
|
12040
|
+
}
|
|
12041
|
+
}
|
|
12042
|
+
},
|
|
12043
|
+
"responses": {
|
|
12044
|
+
"200": {
|
|
12045
|
+
"description": "Successful Response",
|
|
12046
|
+
"content": {
|
|
12047
|
+
"application/json": {
|
|
12048
|
+
"schema": {
|
|
12049
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
12050
|
+
}
|
|
12051
|
+
}
|
|
12052
|
+
}
|
|
12053
|
+
},
|
|
12054
|
+
"422": {
|
|
12055
|
+
"description": "Validation Error",
|
|
12056
|
+
"content": {
|
|
12057
|
+
"application/json": {
|
|
12058
|
+
"schema": {
|
|
12059
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12060
|
+
}
|
|
12061
|
+
}
|
|
12062
|
+
}
|
|
12063
|
+
}
|
|
12064
|
+
}
|
|
12065
|
+
},
|
|
12066
|
+
"put": {
|
|
12067
|
+
"tags": [
|
|
12068
|
+
"users",
|
|
12069
|
+
"V1"
|
|
12070
|
+
],
|
|
12071
|
+
"summary": "Update User",
|
|
12072
|
+
"description": "Update an existing user.",
|
|
12073
|
+
"operationId": "users_update",
|
|
12074
|
+
"security": [
|
|
12075
|
+
{
|
|
12076
|
+
"APIKeyHeader": []
|
|
12077
|
+
}
|
|
12078
|
+
],
|
|
12079
|
+
"requestBody": {
|
|
12080
|
+
"required": true,
|
|
12081
|
+
"content": {
|
|
12082
|
+
"application/json": {
|
|
12083
|
+
"schema": {
|
|
12084
|
+
"$ref": "#/components/schemas/UserUpdateRequest"
|
|
12085
|
+
}
|
|
12086
|
+
}
|
|
12087
|
+
}
|
|
12088
|
+
},
|
|
12089
|
+
"responses": {
|
|
12090
|
+
"200": {
|
|
12091
|
+
"description": "Successful Response",
|
|
12092
|
+
"content": {
|
|
12093
|
+
"application/json": {
|
|
12094
|
+
"schema": {
|
|
12095
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
12096
|
+
}
|
|
12097
|
+
}
|
|
12098
|
+
}
|
|
12099
|
+
},
|
|
12100
|
+
"422": {
|
|
12101
|
+
"description": "Validation Error",
|
|
12102
|
+
"content": {
|
|
12103
|
+
"application/json": {
|
|
12104
|
+
"schema": {
|
|
12105
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12106
|
+
}
|
|
12107
|
+
}
|
|
12108
|
+
}
|
|
12109
|
+
}
|
|
12110
|
+
}
|
|
12111
|
+
},
|
|
12112
|
+
"delete": {
|
|
12113
|
+
"tags": [
|
|
12114
|
+
"users",
|
|
12115
|
+
"V1"
|
|
12116
|
+
],
|
|
12117
|
+
"summary": "Delete User",
|
|
12118
|
+
"description": "Delete a user.",
|
|
12119
|
+
"operationId": "users_delete",
|
|
12120
|
+
"security": [
|
|
12121
|
+
{
|
|
12122
|
+
"APIKeyHeader": []
|
|
12123
|
+
}
|
|
12124
|
+
],
|
|
12125
|
+
"requestBody": {
|
|
12126
|
+
"required": true,
|
|
12127
|
+
"content": {
|
|
12128
|
+
"application/json": {
|
|
12129
|
+
"schema": {
|
|
12130
|
+
"$ref": "#/components/schemas/UserDeleteRequest"
|
|
12131
|
+
}
|
|
12132
|
+
}
|
|
12133
|
+
}
|
|
12134
|
+
},
|
|
12135
|
+
"responses": {
|
|
12136
|
+
"200": {
|
|
12137
|
+
"description": "Successful Response",
|
|
12138
|
+
"content": {
|
|
12139
|
+
"application/json": {
|
|
12140
|
+
"schema": {}
|
|
12141
|
+
}
|
|
12142
|
+
}
|
|
12143
|
+
},
|
|
12144
|
+
"422": {
|
|
12145
|
+
"description": "Validation Error",
|
|
12146
|
+
"content": {
|
|
12147
|
+
"application/json": {
|
|
12148
|
+
"schema": {
|
|
12149
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12150
|
+
}
|
|
12151
|
+
}
|
|
12152
|
+
}
|
|
12153
|
+
}
|
|
12154
|
+
}
|
|
12155
|
+
}
|
|
12156
|
+
},
|
|
12157
|
+
"/api/v1/users/{user_email}": {
|
|
12158
|
+
"get": {
|
|
12159
|
+
"tags": [
|
|
12160
|
+
"users",
|
|
12161
|
+
"V1"
|
|
12162
|
+
],
|
|
12163
|
+
"summary": "Get User",
|
|
12164
|
+
"description": "Fetch a given user.",
|
|
12165
|
+
"operationId": "users_get_by_email",
|
|
12166
|
+
"security": [
|
|
12167
|
+
{
|
|
12168
|
+
"APIKeyHeader": []
|
|
12169
|
+
}
|
|
12170
|
+
],
|
|
12171
|
+
"parameters": [
|
|
12172
|
+
{
|
|
12173
|
+
"name": "user_email",
|
|
12174
|
+
"in": "path",
|
|
12175
|
+
"required": true,
|
|
12176
|
+
"schema": {
|
|
12177
|
+
"type": "string",
|
|
12178
|
+
"title": "User Email"
|
|
12179
|
+
}
|
|
12180
|
+
}
|
|
12181
|
+
],
|
|
12182
|
+
"responses": {
|
|
12183
|
+
"200": {
|
|
12184
|
+
"description": "Successful Response",
|
|
12185
|
+
"content": {
|
|
12186
|
+
"application/json": {
|
|
12187
|
+
"schema": {
|
|
12188
|
+
"$ref": "#/components/schemas/UserResponse"
|
|
12189
|
+
}
|
|
12190
|
+
}
|
|
12191
|
+
}
|
|
12192
|
+
},
|
|
12193
|
+
"422": {
|
|
12194
|
+
"description": "Validation Error",
|
|
12195
|
+
"content": {
|
|
12196
|
+
"application/json": {
|
|
12197
|
+
"schema": {
|
|
12198
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12199
|
+
}
|
|
12200
|
+
}
|
|
12201
|
+
}
|
|
12202
|
+
}
|
|
12203
|
+
}
|
|
12204
|
+
}
|
|
12205
|
+
},
|
|
12206
|
+
"/api/v1/users/{user_email}/send_email": {
|
|
12207
|
+
"post": {
|
|
12208
|
+
"tags": [
|
|
12209
|
+
"users",
|
|
12210
|
+
"V1"
|
|
12211
|
+
],
|
|
12212
|
+
"summary": "Send User Email",
|
|
12213
|
+
"description": "Send a welcome email to a user.",
|
|
12214
|
+
"operationId": "users_send_email",
|
|
12215
|
+
"security": [
|
|
12216
|
+
{
|
|
12217
|
+
"APIKeyHeader": []
|
|
12218
|
+
}
|
|
12219
|
+
],
|
|
12220
|
+
"parameters": [
|
|
12221
|
+
{
|
|
12222
|
+
"name": "user_email",
|
|
12223
|
+
"in": "path",
|
|
12224
|
+
"required": true,
|
|
12225
|
+
"schema": {
|
|
12226
|
+
"type": "string",
|
|
12227
|
+
"title": "User Email"
|
|
12228
|
+
}
|
|
12229
|
+
},
|
|
12230
|
+
{
|
|
12231
|
+
"name": "skip_auth",
|
|
12232
|
+
"in": "query",
|
|
12233
|
+
"required": false,
|
|
12234
|
+
"schema": {
|
|
12235
|
+
"type": "boolean",
|
|
12236
|
+
"default": false,
|
|
12237
|
+
"title": "Skip Auth"
|
|
12238
|
+
}
|
|
12239
|
+
}
|
|
12240
|
+
],
|
|
12241
|
+
"responses": {
|
|
12242
|
+
"200": {
|
|
12243
|
+
"description": "Successful Response",
|
|
12244
|
+
"content": {
|
|
12245
|
+
"application/json": {
|
|
12246
|
+
"schema": {}
|
|
12247
|
+
}
|
|
12248
|
+
}
|
|
12249
|
+
},
|
|
12250
|
+
"422": {
|
|
12251
|
+
"description": "Validation Error",
|
|
12252
|
+
"content": {
|
|
12253
|
+
"application/json": {
|
|
12254
|
+
"schema": {
|
|
12255
|
+
"$ref": "#/components/schemas/HTTPValidationError"
|
|
12256
|
+
}
|
|
12257
|
+
}
|
|
12258
|
+
}
|
|
12259
|
+
}
|
|
12260
|
+
}
|
|
12261
|
+
}
|
|
12262
|
+
},
|
|
12263
|
+
"/api/v1/users/delete_account": {
|
|
12264
|
+
"delete": {
|
|
12265
|
+
"tags": [
|
|
12266
|
+
"users",
|
|
12267
|
+
"V1"
|
|
12268
|
+
],
|
|
12269
|
+
"summary": "Request Removal Of This Account",
|
|
12270
|
+
"description": "Request removal of the account of the user calling this endpoint. Intended for removing trial\naccounts.",
|
|
12271
|
+
"operationId": "users_delete_account",
|
|
12272
|
+
"responses": {
|
|
12273
|
+
"200": {
|
|
12274
|
+
"description": "Successful Response",
|
|
12275
|
+
"content": {
|
|
12276
|
+
"application/json": {
|
|
12277
|
+
"schema": {}
|
|
11815
12278
|
}
|
|
11816
12279
|
}
|
|
11817
12280
|
}
|
|
@@ -13187,7 +13650,7 @@
|
|
|
13187
13650
|
"title": "Batch Id",
|
|
13188
13651
|
"description": "Unique ID for conversation batch",
|
|
13189
13652
|
"examples": [
|
|
13190
|
-
"
|
|
13653
|
+
"20251016.9"
|
|
13191
13654
|
]
|
|
13192
13655
|
},
|
|
13193
13656
|
"campaign_id": {
|
|
@@ -13211,7 +13674,7 @@
|
|
|
13211
13674
|
"title": "Expires On",
|
|
13212
13675
|
"description": "Timestamp of batch expiration",
|
|
13213
13676
|
"examples": [
|
|
13214
|
-
"2025-10-
|
|
13677
|
+
"2025-10-17T00:00:00Z"
|
|
13215
13678
|
]
|
|
13216
13679
|
},
|
|
13217
13680
|
"paused": {
|
|
@@ -13264,7 +13727,7 @@
|
|
|
13264
13727
|
"title": "Created At",
|
|
13265
13728
|
"description": "Timestamp of batch creation",
|
|
13266
13729
|
"examples": [
|
|
13267
|
-
"2025-10-
|
|
13730
|
+
"2025-10-16T00:00:00Z"
|
|
13268
13731
|
]
|
|
13269
13732
|
},
|
|
13270
13733
|
"deleted_at": {
|
|
@@ -13280,7 +13743,7 @@
|
|
|
13280
13743
|
"title": "Deleted At",
|
|
13281
13744
|
"description": "Timestamp of batch deletion",
|
|
13282
13745
|
"examples": [
|
|
13283
|
-
"2025-10-
|
|
13746
|
+
"2025-10-16T00:00:00Z"
|
|
13284
13747
|
]
|
|
13285
13748
|
},
|
|
13286
13749
|
"deleted_reason": {
|
|
@@ -13311,7 +13774,7 @@
|
|
|
13311
13774
|
"title": "Last Updated At",
|
|
13312
13775
|
"description": "Timestamp of last change to batch",
|
|
13313
13776
|
"examples": [
|
|
13314
|
-
"2025-10-
|
|
13777
|
+
"2025-10-16T00:00:00Z"
|
|
13315
13778
|
]
|
|
13316
13779
|
},
|
|
13317
13780
|
"last_updated_by": {
|
|
@@ -13776,7 +14239,8 @@
|
|
|
13776
14239
|
"sip",
|
|
13777
14240
|
"twilio",
|
|
13778
14241
|
"email",
|
|
13779
|
-
"webchat"
|
|
14242
|
+
"webchat",
|
|
14243
|
+
"africastalking"
|
|
13780
14244
|
],
|
|
13781
14245
|
"title": "ChannelServices",
|
|
13782
14246
|
"description": "The communication service for a channel."
|
|
@@ -14066,7 +14530,7 @@
|
|
|
14066
14530
|
"title": "Batch Id",
|
|
14067
14531
|
"description": "Unique ID for conversation batch",
|
|
14068
14532
|
"examples": [
|
|
14069
|
-
"
|
|
14533
|
+
"20251016.9"
|
|
14070
14534
|
]
|
|
14071
14535
|
},
|
|
14072
14536
|
"campaign_id": {
|
|
@@ -14090,7 +14554,7 @@
|
|
|
14090
14554
|
"title": "Expires On",
|
|
14091
14555
|
"description": "Timestamp of batch expiration",
|
|
14092
14556
|
"examples": [
|
|
14093
|
-
"2025-10-
|
|
14557
|
+
"2025-10-17T00:00:00Z"
|
|
14094
14558
|
]
|
|
14095
14559
|
},
|
|
14096
14560
|
"paused": {
|
|
@@ -14143,7 +14607,7 @@
|
|
|
14143
14607
|
"title": "Created At",
|
|
14144
14608
|
"description": "Timestamp of batch creation",
|
|
14145
14609
|
"examples": [
|
|
14146
|
-
"2025-10-
|
|
14610
|
+
"2025-10-16T00:00:00Z"
|
|
14147
14611
|
]
|
|
14148
14612
|
},
|
|
14149
14613
|
"deleted_at": {
|
|
@@ -14159,7 +14623,7 @@
|
|
|
14159
14623
|
"title": "Deleted At",
|
|
14160
14624
|
"description": "Timestamp of batch deletion",
|
|
14161
14625
|
"examples": [
|
|
14162
|
-
"2025-10-
|
|
14626
|
+
"2025-10-16T00:00:00Z"
|
|
14163
14627
|
]
|
|
14164
14628
|
},
|
|
14165
14629
|
"deleted_reason": {
|
|
@@ -14190,7 +14654,7 @@
|
|
|
14190
14654
|
"title": "Last Updated At",
|
|
14191
14655
|
"description": "Timestamp of last change to batch",
|
|
14192
14656
|
"examples": [
|
|
14193
|
-
"2025-10-
|
|
14657
|
+
"2025-10-16T00:00:00Z"
|
|
14194
14658
|
]
|
|
14195
14659
|
},
|
|
14196
14660
|
"last_updated_by": {
|
|
@@ -14233,7 +14697,7 @@
|
|
|
14233
14697
|
"title": "Batch Id",
|
|
14234
14698
|
"description": "Unique ID for conversation batch",
|
|
14235
14699
|
"examples": [
|
|
14236
|
-
"
|
|
14700
|
+
"20251016.9"
|
|
14237
14701
|
]
|
|
14238
14702
|
},
|
|
14239
14703
|
"campaign_id": {
|
|
@@ -14257,7 +14721,7 @@
|
|
|
14257
14721
|
"title": "Expires On",
|
|
14258
14722
|
"description": "Timestamp of batch expiration",
|
|
14259
14723
|
"examples": [
|
|
14260
|
-
"2025-10-
|
|
14724
|
+
"2025-10-17T00:00:00Z"
|
|
14261
14725
|
]
|
|
14262
14726
|
},
|
|
14263
14727
|
"paused": {
|
|
@@ -14406,7 +14870,7 @@
|
|
|
14406
14870
|
"title": "Created At",
|
|
14407
14871
|
"description": "Timestamp of request creation",
|
|
14408
14872
|
"examples": [
|
|
14409
|
-
"2025-10-
|
|
14873
|
+
"2025-10-15T00:00:00Z"
|
|
14410
14874
|
]
|
|
14411
14875
|
},
|
|
14412
14876
|
"sent_at": {
|
|
@@ -14422,7 +14886,7 @@
|
|
|
14422
14886
|
"title": "Sent At",
|
|
14423
14887
|
"description": "Timestamp at which request was sent",
|
|
14424
14888
|
"examples": [
|
|
14425
|
-
"2025-10-
|
|
14889
|
+
"2025-10-16T00:00:00Z"
|
|
14426
14890
|
]
|
|
14427
14891
|
},
|
|
14428
14892
|
"attempt_count": {
|
|
@@ -16363,7 +16827,7 @@
|
|
|
16363
16827
|
"title": "Created At",
|
|
16364
16828
|
"description": "Timestamp at which insight upload folder was created",
|
|
16365
16829
|
"examples": [
|
|
16366
|
-
"2025-10-
|
|
16830
|
+
"2025-10-15T00:00:00Z"
|
|
16367
16831
|
]
|
|
16368
16832
|
},
|
|
16369
16833
|
"updated_at": {
|
|
@@ -16372,7 +16836,7 @@
|
|
|
16372
16836
|
"title": "Updated At",
|
|
16373
16837
|
"description": "Timestamp at which insight upload folder was last updated",
|
|
16374
16838
|
"examples": [
|
|
16375
|
-
"2025-10-
|
|
16839
|
+
"2025-10-16T00:00:00Z"
|
|
16376
16840
|
]
|
|
16377
16841
|
},
|
|
16378
16842
|
"last_updated_by": {
|
|
@@ -17058,7 +17522,7 @@
|
|
|
17058
17522
|
"title": "Created At",
|
|
17059
17523
|
"description": "Timestamp of at which insight tool configuration was created",
|
|
17060
17524
|
"examples": [
|
|
17061
|
-
"2025-10-
|
|
17525
|
+
"2025-10-15T00:00:00Z"
|
|
17062
17526
|
]
|
|
17063
17527
|
},
|
|
17064
17528
|
"updated_at": {
|
|
@@ -17067,7 +17531,7 @@
|
|
|
17067
17531
|
"title": "Updated At",
|
|
17068
17532
|
"description": "Timestamp at which insight tool configuration was last updated",
|
|
17069
17533
|
"examples": [
|
|
17070
|
-
"2025-10-
|
|
17534
|
+
"2025-10-16T00:00:00Z"
|
|
17071
17535
|
]
|
|
17072
17536
|
},
|
|
17073
17537
|
"last_updated_by": {
|
|
@@ -17448,7 +17912,7 @@
|
|
|
17448
17912
|
"title": "Start Datetime",
|
|
17449
17913
|
"description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
|
|
17450
17914
|
"examples": [
|
|
17451
|
-
"2025-10-
|
|
17915
|
+
"2025-10-15T00:00:00Z"
|
|
17452
17916
|
]
|
|
17453
17917
|
},
|
|
17454
17918
|
"end_datetime": {
|
|
@@ -17464,7 +17928,7 @@
|
|
|
17464
17928
|
"title": "End Datetime",
|
|
17465
17929
|
"description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
|
|
17466
17930
|
"examples": [
|
|
17467
|
-
"2025-10-
|
|
17931
|
+
"2025-10-16T00:00:00Z"
|
|
17468
17932
|
]
|
|
17469
17933
|
}
|
|
17470
17934
|
},
|
|
@@ -17539,7 +18003,7 @@
|
|
|
17539
18003
|
"title": "Start Datetime",
|
|
17540
18004
|
"description": "Target session timestamp the workflow (backfill) should start. An empty value indicates start on activation - live sessions only",
|
|
17541
18005
|
"examples": [
|
|
17542
|
-
"2025-10-
|
|
18006
|
+
"2025-10-15T00:00:00Z"
|
|
17543
18007
|
]
|
|
17544
18008
|
},
|
|
17545
18009
|
"end_datetime": {
|
|
@@ -17555,7 +18019,7 @@
|
|
|
17555
18019
|
"title": "End Datetime",
|
|
17556
18020
|
"description": "Target session timestamp the workflow (backfill) should end. An empty value indicates no end, i.e., include live sessions until deactivation",
|
|
17557
18021
|
"examples": [
|
|
17558
|
-
"2025-10-
|
|
18022
|
+
"2025-10-16T00:00:00Z"
|
|
17559
18023
|
]
|
|
17560
18024
|
},
|
|
17561
18025
|
"id": {
|
|
@@ -17608,7 +18072,7 @@
|
|
|
17608
18072
|
"title": "Created At",
|
|
17609
18073
|
"description": "Timestamp at which the insight workflow was created",
|
|
17610
18074
|
"examples": [
|
|
17611
|
-
"2025-10-
|
|
18075
|
+
"2025-10-15T00:00:00Z"
|
|
17612
18076
|
]
|
|
17613
18077
|
},
|
|
17614
18078
|
"updated_at": {
|
|
@@ -17617,7 +18081,7 @@
|
|
|
17617
18081
|
"title": "Updated At",
|
|
17618
18082
|
"description": "Timestamp of most recent update to the insight workflow",
|
|
17619
18083
|
"examples": [
|
|
17620
|
-
"2025-10-
|
|
18084
|
+
"2025-10-16T00:00:00Z"
|
|
17621
18085
|
]
|
|
17622
18086
|
},
|
|
17623
18087
|
"last_updated_by": {
|
|
@@ -17713,7 +18177,7 @@
|
|
|
17713
18177
|
"title": "Created At",
|
|
17714
18178
|
"description": "Timestamp at which insight upload folder was created",
|
|
17715
18179
|
"examples": [
|
|
17716
|
-
"2025-10-
|
|
18180
|
+
"2025-10-15T00:00:00Z"
|
|
17717
18181
|
]
|
|
17718
18182
|
},
|
|
17719
18183
|
"updated_at": {
|
|
@@ -17722,7 +18186,7 @@
|
|
|
17722
18186
|
"title": "Updated At",
|
|
17723
18187
|
"description": "Timestamp at which insight upload folder was last updated",
|
|
17724
18188
|
"examples": [
|
|
17725
|
-
"2025-10-
|
|
18189
|
+
"2025-10-16T00:00:00Z"
|
|
17726
18190
|
]
|
|
17727
18191
|
},
|
|
17728
18192
|
"last_updated_by": {
|
|
@@ -17957,7 +18421,7 @@
|
|
|
17957
18421
|
"title": "Created At",
|
|
17958
18422
|
"description": "Timestamp at which insight tool result was created",
|
|
17959
18423
|
"examples": [
|
|
17960
|
-
"2025-10-
|
|
18424
|
+
"2025-10-15T00:00:00Z"
|
|
17961
18425
|
]
|
|
17962
18426
|
},
|
|
17963
18427
|
"updated_at": {
|
|
@@ -17966,7 +18430,7 @@
|
|
|
17966
18430
|
"title": "Updated At",
|
|
17967
18431
|
"description": "Timestamp at which insight tool result was last updated",
|
|
17968
18432
|
"examples": [
|
|
17969
|
-
"2025-10-
|
|
18433
|
+
"2025-10-16T00:00:00Z"
|
|
17970
18434
|
]
|
|
17971
18435
|
},
|
|
17972
18436
|
"upload_file_metadata": {
|
|
@@ -18111,7 +18575,7 @@
|
|
|
18111
18575
|
"title": "Start Time",
|
|
18112
18576
|
"description": "Start time of the uploaded file",
|
|
18113
18577
|
"examples": [
|
|
18114
|
-
"2025-10-
|
|
18578
|
+
"2025-10-15T00:00:00Z"
|
|
18115
18579
|
]
|
|
18116
18580
|
},
|
|
18117
18581
|
"end_time": {
|
|
@@ -18127,7 +18591,7 @@
|
|
|
18127
18591
|
"title": "End Time",
|
|
18128
18592
|
"description": "End time of the uploaded file",
|
|
18129
18593
|
"examples": [
|
|
18130
|
-
"2025-10-
|
|
18594
|
+
"2025-10-16T00:00:00Z"
|
|
18131
18595
|
]
|
|
18132
18596
|
},
|
|
18133
18597
|
"error_message": {
|
|
@@ -18182,7 +18646,7 @@
|
|
|
18182
18646
|
"title": "Created At",
|
|
18183
18647
|
"description": "Timestamp at which insight upload file was created",
|
|
18184
18648
|
"examples": [
|
|
18185
|
-
"2025-10-
|
|
18649
|
+
"2025-10-15T00:00:00Z"
|
|
18186
18650
|
]
|
|
18187
18651
|
}
|
|
18188
18652
|
},
|
|
@@ -18500,7 +18964,7 @@
|
|
|
18500
18964
|
"skip_current_language_in_message"
|
|
18501
18965
|
],
|
|
18502
18966
|
"title": "LanguageGroupCreateRequest",
|
|
18503
|
-
"description": "Request model to create a
|
|
18967
|
+
"description": "Request model to create a voice group."
|
|
18504
18968
|
},
|
|
18505
18969
|
"LanguageGroupProperties": {
|
|
18506
18970
|
"type": "string",
|
|
@@ -18512,7 +18976,7 @@
|
|
|
18512
18976
|
"last_updated_by"
|
|
18513
18977
|
],
|
|
18514
18978
|
"title": "LanguageGroupProperties",
|
|
18515
|
-
"description": "
|
|
18979
|
+
"description": "Deprecated enum mirroring `VoiceGroupProperties` values."
|
|
18516
18980
|
},
|
|
18517
18981
|
"LanguageGroupResponse": {
|
|
18518
18982
|
"properties": {
|
|
@@ -18645,7 +19109,7 @@
|
|
|
18645
19109
|
"last_updated_by"
|
|
18646
19110
|
],
|
|
18647
19111
|
"title": "LanguageGroupResponse",
|
|
18648
|
-
"description": "Response model for
|
|
19112
|
+
"description": "Response model for voice group operations.\nA voice group is a collection of language, voice, and DTMF configuration that can be\nlinked to an agent to define the languages and voices it supports. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/VoiceGroups)."
|
|
18649
19113
|
},
|
|
18650
19114
|
"LanguageGroupUpdateRequest": {
|
|
18651
19115
|
"properties": {
|
|
@@ -18736,7 +19200,82 @@
|
|
|
18736
19200
|
"id"
|
|
18737
19201
|
],
|
|
18738
19202
|
"title": "LanguageGroupUpdateRequest",
|
|
18739
|
-
"description": "Request model to update an existing
|
|
19203
|
+
"description": "Request model to update an existing voice group."
|
|
19204
|
+
},
|
|
19205
|
+
"LanguageSampleCreateRequest": {
|
|
19206
|
+
"properties": {
|
|
19207
|
+
"language_code": {
|
|
19208
|
+
"$ref": "#/components/schemas/LanguageCode",
|
|
19209
|
+
"description": "BCP 47 code of the language",
|
|
19210
|
+
"examples": [
|
|
19211
|
+
"en-US"
|
|
19212
|
+
]
|
|
19213
|
+
},
|
|
19214
|
+
"voice_provider": {
|
|
19215
|
+
"$ref": "#/components/schemas/TtsProvider",
|
|
19216
|
+
"description": "TTS provider of the voice to use for the language",
|
|
19217
|
+
"examples": [
|
|
19218
|
+
"OpenAI"
|
|
19219
|
+
]
|
|
19220
|
+
},
|
|
19221
|
+
"voice_display_name": {
|
|
19222
|
+
"$ref": "#/components/schemas/AgentVoiceDisplayName",
|
|
19223
|
+
"description": "Display name of the voice to use for the language",
|
|
19224
|
+
"examples": [
|
|
19225
|
+
"Alloy"
|
|
19226
|
+
]
|
|
19227
|
+
},
|
|
19228
|
+
"voice_speed": {
|
|
19229
|
+
"anyOf": [
|
|
19230
|
+
{
|
|
19231
|
+
"type": "number"
|
|
19232
|
+
},
|
|
19233
|
+
{
|
|
19234
|
+
"type": "null"
|
|
19235
|
+
}
|
|
19236
|
+
],
|
|
19237
|
+
"title": "Voice Speed",
|
|
19238
|
+
"description": "Speed of the voice in the range of 0.25 to 4.0 (OpenAI and Google) or 0.7 to 1.2 (ElevenLabs). Standard speed is 1.0.",
|
|
19239
|
+
"examples": [
|
|
19240
|
+
1.0
|
|
19241
|
+
]
|
|
19242
|
+
},
|
|
19243
|
+
"voice_pitch": {
|
|
19244
|
+
"anyOf": [
|
|
19245
|
+
{
|
|
19246
|
+
"type": "number"
|
|
19247
|
+
},
|
|
19248
|
+
{
|
|
19249
|
+
"type": "null"
|
|
19250
|
+
}
|
|
19251
|
+
],
|
|
19252
|
+
"title": "Voice Pitch",
|
|
19253
|
+
"description": "Pitch of the voice in the range of -20.0 to 20.0. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. 0 means use the original pitch. Only supported for Google configs.",
|
|
19254
|
+
"examples": [
|
|
19255
|
+
0.0
|
|
19256
|
+
]
|
|
19257
|
+
},
|
|
19258
|
+
"text": {
|
|
19259
|
+
"type": "string",
|
|
19260
|
+
"title": "Text",
|
|
19261
|
+
"description": "Text to generate for this voice.",
|
|
19262
|
+
"default": ""
|
|
19263
|
+
},
|
|
19264
|
+
"apply_pronunciation_overrides": {
|
|
19265
|
+
"type": "boolean",
|
|
19266
|
+
"title": "Apply Pronunciation Overrides",
|
|
19267
|
+
"description": "Apply TTS pronunciation fixes.",
|
|
19268
|
+
"default": false
|
|
19269
|
+
}
|
|
19270
|
+
},
|
|
19271
|
+
"type": "object",
|
|
19272
|
+
"required": [
|
|
19273
|
+
"language_code",
|
|
19274
|
+
"voice_provider",
|
|
19275
|
+
"voice_display_name"
|
|
19276
|
+
],
|
|
19277
|
+
"title": "LanguageSampleCreateRequest",
|
|
19278
|
+
"description": "Request model to generate a sample audio file for a given voice and language."
|
|
18740
19279
|
},
|
|
18741
19280
|
"LatencyCategory": {
|
|
18742
19281
|
"type": "string",
|
|
@@ -20539,6 +21078,72 @@
|
|
|
20539
21078
|
],
|
|
20540
21079
|
"title": "ListResponse[UserResponse]"
|
|
20541
21080
|
},
|
|
21081
|
+
"ListResponse_VoiceGroupResponse_": {
|
|
21082
|
+
"properties": {
|
|
21083
|
+
"items": {
|
|
21084
|
+
"items": {
|
|
21085
|
+
"$ref": "#/components/schemas/VoiceGroupResponse"
|
|
21086
|
+
},
|
|
21087
|
+
"type": "array",
|
|
21088
|
+
"title": "Items",
|
|
21089
|
+
"description": "List of items returned from the query",
|
|
21090
|
+
"examples": []
|
|
21091
|
+
},
|
|
21092
|
+
"page": {
|
|
21093
|
+
"type": "integer",
|
|
21094
|
+
"title": "Page",
|
|
21095
|
+
"description": "The page number of the results (0-based)",
|
|
21096
|
+
"examples": [
|
|
21097
|
+
0
|
|
21098
|
+
]
|
|
21099
|
+
},
|
|
21100
|
+
"page_size": {
|
|
21101
|
+
"type": "integer",
|
|
21102
|
+
"title": "Page Size",
|
|
21103
|
+
"description": "The number of items returned per page",
|
|
21104
|
+
"examples": [
|
|
21105
|
+
25
|
|
21106
|
+
]
|
|
21107
|
+
},
|
|
21108
|
+
"total_pages": {
|
|
21109
|
+
"anyOf": [
|
|
21110
|
+
{
|
|
21111
|
+
"type": "integer"
|
|
21112
|
+
},
|
|
21113
|
+
{
|
|
21114
|
+
"type": "null"
|
|
21115
|
+
}
|
|
21116
|
+
],
|
|
21117
|
+
"title": "Total Pages",
|
|
21118
|
+
"description": "The total number of pages of results given the indicated page size",
|
|
21119
|
+
"examples": [
|
|
21120
|
+
4
|
|
21121
|
+
]
|
|
21122
|
+
},
|
|
21123
|
+
"total_count": {
|
|
21124
|
+
"anyOf": [
|
|
21125
|
+
{
|
|
21126
|
+
"type": "integer"
|
|
21127
|
+
},
|
|
21128
|
+
{
|
|
21129
|
+
"type": "null"
|
|
21130
|
+
}
|
|
21131
|
+
],
|
|
21132
|
+
"title": "Total Count",
|
|
21133
|
+
"description": "The total number of items returned from the query",
|
|
21134
|
+
"examples": [
|
|
21135
|
+
100
|
|
21136
|
+
]
|
|
21137
|
+
}
|
|
21138
|
+
},
|
|
21139
|
+
"type": "object",
|
|
21140
|
+
"required": [
|
|
21141
|
+
"items",
|
|
21142
|
+
"page",
|
|
21143
|
+
"page_size"
|
|
21144
|
+
],
|
|
21145
|
+
"title": "ListResponse[VoiceGroupResponse]"
|
|
21146
|
+
},
|
|
20542
21147
|
"LoginType": {
|
|
20543
21148
|
"type": "string",
|
|
20544
21149
|
"enum": [
|
|
@@ -20598,6 +21203,27 @@
|
|
|
20598
21203
|
"sometoken"
|
|
20599
21204
|
]
|
|
20600
21205
|
},
|
|
21206
|
+
"provider_credentials": {
|
|
21207
|
+
"anyOf": [
|
|
21208
|
+
{
|
|
21209
|
+
"additionalProperties": {
|
|
21210
|
+
"type": "string"
|
|
21211
|
+
},
|
|
21212
|
+
"type": "object"
|
|
21213
|
+
},
|
|
21214
|
+
{
|
|
21215
|
+
"type": "null"
|
|
21216
|
+
}
|
|
21217
|
+
],
|
|
21218
|
+
"title": "Provider Credentials",
|
|
21219
|
+
"description": "Provider-specific credentials. Initially to be used for AfricasTalking creds.In a future this would be used for Twilio creds too (removing the account_sid and auth_token fields).",
|
|
21220
|
+
"examples": [
|
|
21221
|
+
{
|
|
21222
|
+
"api_key": "atk123",
|
|
21223
|
+
"username": "test_username"
|
|
21224
|
+
}
|
|
21225
|
+
]
|
|
21226
|
+
},
|
|
20601
21227
|
"telephony": {
|
|
20602
21228
|
"anyOf": [
|
|
20603
21229
|
{
|
|
@@ -20677,6 +21303,18 @@
|
|
|
20677
21303
|
"passive_speech_input_enabled": true,
|
|
20678
21304
|
"pre_input_timeout": 3.0
|
|
20679
21305
|
}
|
|
21306
|
+
},
|
|
21307
|
+
{
|
|
21308
|
+
"provider_credentials": {
|
|
21309
|
+
"api_key": "atk123",
|
|
21310
|
+
"username": "test_username"
|
|
21311
|
+
},
|
|
21312
|
+
"telephony": {
|
|
21313
|
+
"interruptibility": "dtmf_only",
|
|
21314
|
+
"passive_input_start": 0.5,
|
|
21315
|
+
"passive_speech_input_enabled": true,
|
|
21316
|
+
"pre_input_timeout": 3.0
|
|
21317
|
+
}
|
|
20680
21318
|
}
|
|
20681
21319
|
]
|
|
20682
21320
|
}
|
|
@@ -20744,6 +21382,18 @@
|
|
|
20744
21382
|
"passive_speech_input_enabled": true,
|
|
20745
21383
|
"pre_input_timeout": 3.0
|
|
20746
21384
|
}
|
|
21385
|
+
},
|
|
21386
|
+
{
|
|
21387
|
+
"provider_credentials": {
|
|
21388
|
+
"api_key": "atk123",
|
|
21389
|
+
"username": "test_username"
|
|
21390
|
+
},
|
|
21391
|
+
"telephony": {
|
|
21392
|
+
"interruptibility": "dtmf_only",
|
|
21393
|
+
"passive_input_start": 0.5,
|
|
21394
|
+
"passive_speech_input_enabled": true,
|
|
21395
|
+
"pre_input_timeout": 3.0
|
|
21396
|
+
}
|
|
20747
21397
|
}
|
|
20748
21398
|
]
|
|
20749
21399
|
},
|
|
@@ -21166,7 +21816,7 @@
|
|
|
21166
21816
|
"title": "Created At",
|
|
21167
21817
|
"description": "Timestamp of campaign creation",
|
|
21168
21818
|
"examples": [
|
|
21169
|
-
"2025-10-
|
|
21819
|
+
"2025-10-16T00:00:00Z"
|
|
21170
21820
|
]
|
|
21171
21821
|
},
|
|
21172
21822
|
"updated_at": {
|
|
@@ -21175,7 +21825,7 @@
|
|
|
21175
21825
|
"title": "Updated At",
|
|
21176
21826
|
"description": "Timestamp of campaign update",
|
|
21177
21827
|
"examples": [
|
|
21178
|
-
"2025-10-
|
|
21828
|
+
"2025-10-16T00:00:00Z"
|
|
21179
21829
|
]
|
|
21180
21830
|
},
|
|
21181
21831
|
"last_updated_by": {
|
|
@@ -25378,41 +26028,305 @@
|
|
|
25378
26028
|
"title": "Sid",
|
|
25379
26029
|
"description": "The unique identifier for the phone number."
|
|
25380
26030
|
},
|
|
25381
|
-
"phone_number": {
|
|
25382
|
-
"type": "string",
|
|
25383
|
-
"title": "Phone Number",
|
|
25384
|
-
"description": "The phone number."
|
|
26031
|
+
"phone_number": {
|
|
26032
|
+
"type": "string",
|
|
26033
|
+
"title": "Phone Number",
|
|
26034
|
+
"description": "The phone number."
|
|
26035
|
+
},
|
|
26036
|
+
"friendly_name": {
|
|
26037
|
+
"type": "string",
|
|
26038
|
+
"title": "Friendly Name",
|
|
26039
|
+
"description": "A user-friendly name for the number."
|
|
26040
|
+
},
|
|
26041
|
+
"trunk_sid": {
|
|
26042
|
+
"type": "string",
|
|
26043
|
+
"title": "Trunk Sid",
|
|
26044
|
+
"description": "Associated trunk SID, if any."
|
|
26045
|
+
}
|
|
26046
|
+
},
|
|
26047
|
+
"type": "object",
|
|
26048
|
+
"required": [
|
|
26049
|
+
"sid",
|
|
26050
|
+
"phone_number",
|
|
26051
|
+
"friendly_name",
|
|
26052
|
+
"trunk_sid"
|
|
26053
|
+
],
|
|
26054
|
+
"title": "TwilioPhoneNumber"
|
|
26055
|
+
},
|
|
26056
|
+
"UserActivityStatus": {
|
|
26057
|
+
"type": "string",
|
|
26058
|
+
"enum": [
|
|
26059
|
+
"not_invited",
|
|
26060
|
+
"invited",
|
|
26061
|
+
"active"
|
|
26062
|
+
],
|
|
26063
|
+
"title": "UserActivityStatus"
|
|
26064
|
+
},
|
|
26065
|
+
"UserCreateRequest": {
|
|
26066
|
+
"properties": {
|
|
26067
|
+
"email": {
|
|
26068
|
+
"type": "string",
|
|
26069
|
+
"title": "Email",
|
|
26070
|
+
"description": "Email address of the user",
|
|
26071
|
+
"examples": [
|
|
26072
|
+
"user@syllable.ai"
|
|
26073
|
+
]
|
|
26074
|
+
},
|
|
26075
|
+
"first_name": {
|
|
26076
|
+
"anyOf": [
|
|
26077
|
+
{
|
|
26078
|
+
"type": "string"
|
|
26079
|
+
},
|
|
26080
|
+
{
|
|
26081
|
+
"type": "null"
|
|
26082
|
+
}
|
|
26083
|
+
],
|
|
26084
|
+
"title": "First Name",
|
|
26085
|
+
"description": "First name of the user",
|
|
26086
|
+
"examples": [
|
|
26087
|
+
"Jane"
|
|
26088
|
+
]
|
|
26089
|
+
},
|
|
26090
|
+
"last_name": {
|
|
26091
|
+
"anyOf": [
|
|
26092
|
+
{
|
|
26093
|
+
"type": "string"
|
|
26094
|
+
},
|
|
26095
|
+
{
|
|
26096
|
+
"type": "null"
|
|
26097
|
+
}
|
|
26098
|
+
],
|
|
26099
|
+
"title": "Last Name",
|
|
26100
|
+
"description": "Last name of the user",
|
|
26101
|
+
"examples": [
|
|
26102
|
+
"Smith"
|
|
26103
|
+
]
|
|
26104
|
+
},
|
|
26105
|
+
"role_id": {
|
|
26106
|
+
"type": "integer",
|
|
26107
|
+
"title": "Role Id",
|
|
26108
|
+
"description": "ID of the role assigned to the user",
|
|
26109
|
+
"examples": [
|
|
26110
|
+
1
|
|
26111
|
+
]
|
|
26112
|
+
},
|
|
26113
|
+
"login_type": {
|
|
26114
|
+
"anyOf": [
|
|
26115
|
+
{
|
|
26116
|
+
"$ref": "#/components/schemas/LoginType"
|
|
26117
|
+
},
|
|
26118
|
+
{
|
|
26119
|
+
"type": "null"
|
|
26120
|
+
}
|
|
26121
|
+
],
|
|
26122
|
+
"description": "The type of login to use for the user. If not provided, defaults to google for @gmail.com email addresses, and username and password otherwise.",
|
|
26123
|
+
"examples": [
|
|
26124
|
+
"username_and_password"
|
|
26125
|
+
]
|
|
26126
|
+
},
|
|
26127
|
+
"skip_auth": {
|
|
26128
|
+
"type": "boolean",
|
|
26129
|
+
"title": "Skip Auth",
|
|
26130
|
+
"description": "Whether to skip authentication for the user.",
|
|
26131
|
+
"default": false
|
|
26132
|
+
}
|
|
26133
|
+
},
|
|
26134
|
+
"type": "object",
|
|
26135
|
+
"required": [
|
|
26136
|
+
"email",
|
|
26137
|
+
"role_id"
|
|
26138
|
+
],
|
|
26139
|
+
"title": "UserCreateRequest",
|
|
26140
|
+
"description": "Request model to create a user."
|
|
26141
|
+
},
|
|
26142
|
+
"UserDeleteRequest": {
|
|
26143
|
+
"properties": {
|
|
26144
|
+
"email": {
|
|
26145
|
+
"type": "string",
|
|
26146
|
+
"title": "Email",
|
|
26147
|
+
"description": "The email address of the user to delete",
|
|
26148
|
+
"examples": [
|
|
26149
|
+
"user@syllable.ai"
|
|
26150
|
+
]
|
|
26151
|
+
},
|
|
26152
|
+
"reason": {
|
|
26153
|
+
"type": "string",
|
|
26154
|
+
"title": "Reason",
|
|
26155
|
+
"description": "The reason for deleting the user",
|
|
26156
|
+
"examples": [
|
|
26157
|
+
"User left the organization"
|
|
26158
|
+
]
|
|
26159
|
+
}
|
|
26160
|
+
},
|
|
26161
|
+
"type": "object",
|
|
26162
|
+
"required": [
|
|
26163
|
+
"email",
|
|
26164
|
+
"reason"
|
|
26165
|
+
],
|
|
26166
|
+
"title": "UserDeleteRequest",
|
|
26167
|
+
"description": "Request model to delete a user."
|
|
26168
|
+
},
|
|
26169
|
+
"UserProperties": {
|
|
26170
|
+
"type": "string",
|
|
26171
|
+
"enum": [
|
|
26172
|
+
"email",
|
|
26173
|
+
"first_name",
|
|
26174
|
+
"last_name",
|
|
26175
|
+
"role_id",
|
|
26176
|
+
"role_name",
|
|
26177
|
+
"email_first_name_last_name",
|
|
26178
|
+
"activity_status",
|
|
26179
|
+
"last_updated"
|
|
26180
|
+
],
|
|
26181
|
+
"title": "UserProperties",
|
|
26182
|
+
"description": "Names of user fields supported for filtering/sorting on list endpoint."
|
|
26183
|
+
},
|
|
26184
|
+
"UserResponse": {
|
|
26185
|
+
"properties": {
|
|
26186
|
+
"email": {
|
|
26187
|
+
"type": "string",
|
|
26188
|
+
"title": "Email",
|
|
26189
|
+
"description": "Email address of the user",
|
|
26190
|
+
"examples": [
|
|
26191
|
+
"user@syllable.ai"
|
|
26192
|
+
]
|
|
26193
|
+
},
|
|
26194
|
+
"first_name": {
|
|
26195
|
+
"anyOf": [
|
|
26196
|
+
{
|
|
26197
|
+
"type": "string"
|
|
26198
|
+
},
|
|
26199
|
+
{
|
|
26200
|
+
"type": "null"
|
|
26201
|
+
}
|
|
26202
|
+
],
|
|
26203
|
+
"title": "First Name",
|
|
26204
|
+
"description": "First name of the user",
|
|
26205
|
+
"examples": [
|
|
26206
|
+
"Jane"
|
|
26207
|
+
]
|
|
26208
|
+
},
|
|
26209
|
+
"last_name": {
|
|
26210
|
+
"anyOf": [
|
|
26211
|
+
{
|
|
26212
|
+
"type": "string"
|
|
26213
|
+
},
|
|
26214
|
+
{
|
|
26215
|
+
"type": "null"
|
|
26216
|
+
}
|
|
26217
|
+
],
|
|
26218
|
+
"title": "Last Name",
|
|
26219
|
+
"description": "Last name of the user",
|
|
26220
|
+
"examples": [
|
|
26221
|
+
"Smith"
|
|
26222
|
+
]
|
|
26223
|
+
},
|
|
26224
|
+
"role_id": {
|
|
26225
|
+
"type": "integer",
|
|
26226
|
+
"title": "Role Id",
|
|
26227
|
+
"description": "ID of the role assigned to the user",
|
|
26228
|
+
"examples": [
|
|
26229
|
+
1
|
|
26230
|
+
]
|
|
26231
|
+
},
|
|
26232
|
+
"last_updated_comments": {
|
|
26233
|
+
"anyOf": [
|
|
26234
|
+
{
|
|
26235
|
+
"type": "string"
|
|
26236
|
+
},
|
|
26237
|
+
{
|
|
26238
|
+
"type": "null"
|
|
26239
|
+
}
|
|
26240
|
+
],
|
|
26241
|
+
"title": "Last Updated Comments",
|
|
26242
|
+
"description": "Comments for the most recent edit to the user.",
|
|
26243
|
+
"examples": [
|
|
26244
|
+
"Updated to change which role was assigned"
|
|
26245
|
+
]
|
|
26246
|
+
},
|
|
26247
|
+
"id": {
|
|
26248
|
+
"type": "integer",
|
|
26249
|
+
"title": "Id",
|
|
26250
|
+
"description": "Internal ID of the user",
|
|
26251
|
+
"examples": [
|
|
26252
|
+
1
|
|
26253
|
+
]
|
|
26254
|
+
},
|
|
26255
|
+
"role_name": {
|
|
26256
|
+
"type": "string",
|
|
26257
|
+
"title": "Role Name",
|
|
26258
|
+
"description": "Name of the role assigned to the user",
|
|
26259
|
+
"examples": [
|
|
26260
|
+
"Admin"
|
|
26261
|
+
]
|
|
26262
|
+
},
|
|
26263
|
+
"email_sent": {
|
|
26264
|
+
"type": "boolean",
|
|
26265
|
+
"title": "Email Sent",
|
|
26266
|
+
"description": "Whether the welcome email has been sent to the user",
|
|
26267
|
+
"examples": [
|
|
26268
|
+
true
|
|
26269
|
+
]
|
|
26270
|
+
},
|
|
26271
|
+
"activity_status": {
|
|
26272
|
+
"$ref": "#/components/schemas/UserActivityStatus",
|
|
26273
|
+
"description": "The activity status of the user",
|
|
26274
|
+
"examples": [
|
|
26275
|
+
"invited"
|
|
26276
|
+
]
|
|
25385
26277
|
},
|
|
25386
|
-
"
|
|
26278
|
+
"last_updated": {
|
|
25387
26279
|
"type": "string",
|
|
25388
|
-
"
|
|
25389
|
-
"
|
|
26280
|
+
"format": "date-time",
|
|
26281
|
+
"title": "Last Updated",
|
|
26282
|
+
"description": "The timestamp of the most recent update to the user"
|
|
25390
26283
|
},
|
|
25391
|
-
"
|
|
25392
|
-
"
|
|
25393
|
-
|
|
25394
|
-
|
|
26284
|
+
"last_updated_by": {
|
|
26285
|
+
"anyOf": [
|
|
26286
|
+
{
|
|
26287
|
+
"type": "string"
|
|
26288
|
+
},
|
|
26289
|
+
{
|
|
26290
|
+
"type": "null"
|
|
26291
|
+
}
|
|
26292
|
+
],
|
|
26293
|
+
"title": "Last Updated By",
|
|
26294
|
+
"description": "The email address of the user who last updated the user",
|
|
26295
|
+
"examples": [
|
|
26296
|
+
"admin@email.com"
|
|
26297
|
+
]
|
|
26298
|
+
},
|
|
26299
|
+
"last_session_at": {
|
|
26300
|
+
"anyOf": [
|
|
26301
|
+
{
|
|
26302
|
+
"type": "string",
|
|
26303
|
+
"format": "date-time"
|
|
26304
|
+
},
|
|
26305
|
+
{
|
|
26306
|
+
"type": "null"
|
|
26307
|
+
}
|
|
26308
|
+
],
|
|
26309
|
+
"title": "Last Session At",
|
|
26310
|
+
"description": "The timestamp of the user's last session",
|
|
26311
|
+
"examples": [
|
|
26312
|
+
"2025-01-01T12:00:00Z"
|
|
26313
|
+
]
|
|
25395
26314
|
}
|
|
25396
26315
|
},
|
|
25397
26316
|
"type": "object",
|
|
25398
26317
|
"required": [
|
|
25399
|
-
"
|
|
25400
|
-
"
|
|
25401
|
-
"
|
|
25402
|
-
"
|
|
25403
|
-
|
|
25404
|
-
|
|
25405
|
-
|
|
25406
|
-
"UserActivityStatus": {
|
|
25407
|
-
"type": "string",
|
|
25408
|
-
"enum": [
|
|
25409
|
-
"not_invited",
|
|
25410
|
-
"invited",
|
|
25411
|
-
"active"
|
|
26318
|
+
"email",
|
|
26319
|
+
"role_id",
|
|
26320
|
+
"id",
|
|
26321
|
+
"role_name",
|
|
26322
|
+
"email_sent",
|
|
26323
|
+
"activity_status",
|
|
26324
|
+
"last_updated"
|
|
25412
26325
|
],
|
|
25413
|
-
"title": "
|
|
26326
|
+
"title": "UserResponse",
|
|
26327
|
+
"description": "Information about a user."
|
|
25414
26328
|
},
|
|
25415
|
-
"
|
|
26329
|
+
"UserUpdateRequest": {
|
|
25416
26330
|
"properties": {
|
|
25417
26331
|
"email": {
|
|
25418
26332
|
"type": "string",
|
|
@@ -25460,25 +26374,20 @@
|
|
|
25460
26374
|
1
|
|
25461
26375
|
]
|
|
25462
26376
|
},
|
|
25463
|
-
"
|
|
26377
|
+
"last_updated_comments": {
|
|
25464
26378
|
"anyOf": [
|
|
25465
26379
|
{
|
|
25466
|
-
"
|
|
26380
|
+
"type": "string"
|
|
25467
26381
|
},
|
|
25468
26382
|
{
|
|
25469
26383
|
"type": "null"
|
|
25470
26384
|
}
|
|
25471
26385
|
],
|
|
25472
|
-
"
|
|
26386
|
+
"title": "Last Updated Comments",
|
|
26387
|
+
"description": "Comments for the most recent edit to the user.",
|
|
25473
26388
|
"examples": [
|
|
25474
|
-
"
|
|
26389
|
+
"Updated to change which role was assigned"
|
|
25475
26390
|
]
|
|
25476
|
-
},
|
|
25477
|
-
"skip_auth": {
|
|
25478
|
-
"type": "boolean",
|
|
25479
|
-
"title": "Skip Auth",
|
|
25480
|
-
"description": "Whether to skip authentication for the user.",
|
|
25481
|
-
"default": false
|
|
25482
26391
|
}
|
|
25483
26392
|
},
|
|
25484
26393
|
"type": "object",
|
|
@@ -25486,62 +26395,73 @@
|
|
|
25486
26395
|
"email",
|
|
25487
26396
|
"role_id"
|
|
25488
26397
|
],
|
|
25489
|
-
"title": "
|
|
25490
|
-
"description": "Request model to
|
|
26398
|
+
"title": "UserUpdateRequest",
|
|
26399
|
+
"description": "Request model to update an existing user."
|
|
25491
26400
|
},
|
|
25492
|
-
"
|
|
26401
|
+
"ValidationError": {
|
|
25493
26402
|
"properties": {
|
|
25494
|
-
"
|
|
26403
|
+
"loc": {
|
|
26404
|
+
"items": {
|
|
26405
|
+
"anyOf": [
|
|
26406
|
+
{
|
|
26407
|
+
"type": "string"
|
|
26408
|
+
},
|
|
26409
|
+
{
|
|
26410
|
+
"type": "integer"
|
|
26411
|
+
}
|
|
26412
|
+
]
|
|
26413
|
+
},
|
|
26414
|
+
"type": "array",
|
|
26415
|
+
"title": "Location"
|
|
26416
|
+
},
|
|
26417
|
+
"msg": {
|
|
25495
26418
|
"type": "string",
|
|
25496
|
-
"title": "
|
|
25497
|
-
"description": "The email address of the user to delete",
|
|
25498
|
-
"examples": [
|
|
25499
|
-
"user@syllable.ai"
|
|
25500
|
-
]
|
|
26419
|
+
"title": "Message"
|
|
25501
26420
|
},
|
|
25502
|
-
"
|
|
26421
|
+
"type": {
|
|
25503
26422
|
"type": "string",
|
|
25504
|
-
"title": "
|
|
25505
|
-
"description": "The reason for deleting the user",
|
|
25506
|
-
"examples": [
|
|
25507
|
-
"User left the organization"
|
|
25508
|
-
]
|
|
26423
|
+
"title": "Error Type"
|
|
25509
26424
|
}
|
|
25510
26425
|
},
|
|
25511
26426
|
"type": "object",
|
|
25512
26427
|
"required": [
|
|
25513
|
-
"
|
|
25514
|
-
"
|
|
26428
|
+
"loc",
|
|
26429
|
+
"msg",
|
|
26430
|
+
"type"
|
|
25515
26431
|
],
|
|
25516
|
-
"title": "
|
|
25517
|
-
"description": "Request model to delete a user."
|
|
26432
|
+
"title": "ValidationError"
|
|
25518
26433
|
},
|
|
25519
|
-
"
|
|
25520
|
-
"
|
|
25521
|
-
|
|
25522
|
-
|
|
25523
|
-
|
|
25524
|
-
|
|
25525
|
-
"
|
|
25526
|
-
|
|
25527
|
-
|
|
25528
|
-
|
|
25529
|
-
|
|
26434
|
+
"VoiceDisplayInfo": {
|
|
26435
|
+
"properties": {
|
|
26436
|
+
"display_name": {
|
|
26437
|
+
"type": "string",
|
|
26438
|
+
"title": "Display Name"
|
|
26439
|
+
},
|
|
26440
|
+
"provider": {
|
|
26441
|
+
"type": "string",
|
|
26442
|
+
"title": "Provider"
|
|
26443
|
+
}
|
|
26444
|
+
},
|
|
26445
|
+
"additionalProperties": false,
|
|
26446
|
+
"type": "object",
|
|
26447
|
+
"required": [
|
|
26448
|
+
"display_name",
|
|
26449
|
+
"provider"
|
|
25530
26450
|
],
|
|
25531
|
-
"title": "
|
|
25532
|
-
"description": "
|
|
26451
|
+
"title": "VoiceDisplayInfo",
|
|
26452
|
+
"description": "Display metadata for a canonical voice identifier."
|
|
25533
26453
|
},
|
|
25534
|
-
"
|
|
26454
|
+
"VoiceGroupCreateRequest": {
|
|
25535
26455
|
"properties": {
|
|
25536
|
-
"
|
|
26456
|
+
"name": {
|
|
25537
26457
|
"type": "string",
|
|
25538
|
-
"title": "
|
|
25539
|
-
"description": "
|
|
26458
|
+
"title": "Name",
|
|
26459
|
+
"description": "The name of the language group.",
|
|
25540
26460
|
"examples": [
|
|
25541
|
-
"
|
|
26461
|
+
"Call Center 1 Languages"
|
|
25542
26462
|
]
|
|
25543
26463
|
},
|
|
25544
|
-
"
|
|
26464
|
+
"description": {
|
|
25545
26465
|
"anyOf": [
|
|
25546
26466
|
{
|
|
25547
26467
|
"type": "string"
|
|
@@ -25550,36 +26470,77 @@
|
|
|
25550
26470
|
"type": "null"
|
|
25551
26471
|
}
|
|
25552
26472
|
],
|
|
25553
|
-
"title": "
|
|
25554
|
-
"description": "
|
|
26473
|
+
"title": "Description",
|
|
26474
|
+
"description": "Description of the language group.",
|
|
25555
26475
|
"examples": [
|
|
25556
|
-
"
|
|
26476
|
+
"Languages spoken by operators at Call Center 1"
|
|
25557
26477
|
]
|
|
25558
26478
|
},
|
|
25559
|
-
"
|
|
25560
|
-
"
|
|
25561
|
-
|
|
25562
|
-
|
|
25563
|
-
|
|
25564
|
-
|
|
25565
|
-
|
|
25566
|
-
}
|
|
25567
|
-
],
|
|
25568
|
-
"title": "Last Name",
|
|
25569
|
-
"description": "Last name of the user",
|
|
26479
|
+
"language_configs": {
|
|
26480
|
+
"items": {
|
|
26481
|
+
"$ref": "#/components/schemas/LanguageConfig"
|
|
26482
|
+
},
|
|
26483
|
+
"type": "array",
|
|
26484
|
+
"title": "Language Configs",
|
|
26485
|
+
"description": "Voice and DTMF configurations for each language in the group.",
|
|
25570
26486
|
"examples": [
|
|
25571
|
-
|
|
26487
|
+
[
|
|
26488
|
+
{
|
|
26489
|
+
"dtmf_code": 1,
|
|
26490
|
+
"language_code": "en-US",
|
|
26491
|
+
"voice_display_name": "Alloy",
|
|
26492
|
+
"voice_provider": "OpenAI"
|
|
26493
|
+
},
|
|
26494
|
+
{
|
|
26495
|
+
"dtmf_code": 2,
|
|
26496
|
+
"language_code": "es-US",
|
|
26497
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
26498
|
+
"voice_provider": "Google"
|
|
26499
|
+
}
|
|
26500
|
+
]
|
|
25572
26501
|
]
|
|
25573
26502
|
},
|
|
25574
|
-
"
|
|
25575
|
-
"type": "
|
|
25576
|
-
"title": "
|
|
25577
|
-
"description": "
|
|
26503
|
+
"skip_current_language_in_message": {
|
|
26504
|
+
"type": "boolean",
|
|
26505
|
+
"title": "Skip Current Language In Message",
|
|
26506
|
+
"description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
|
|
26507
|
+
"examples": [
|
|
26508
|
+
true
|
|
26509
|
+
]
|
|
26510
|
+
}
|
|
26511
|
+
},
|
|
26512
|
+
"type": "object",
|
|
26513
|
+
"required": [
|
|
26514
|
+
"name",
|
|
26515
|
+
"language_configs",
|
|
26516
|
+
"skip_current_language_in_message"
|
|
26517
|
+
],
|
|
26518
|
+
"title": "VoiceGroupCreateRequest",
|
|
26519
|
+
"description": "Request model to create a voice group."
|
|
26520
|
+
},
|
|
26521
|
+
"VoiceGroupProperties": {
|
|
26522
|
+
"type": "string",
|
|
26523
|
+
"enum": [
|
|
26524
|
+
"name",
|
|
26525
|
+
"description",
|
|
26526
|
+
"skip_current_language_in_message",
|
|
26527
|
+
"updated_at",
|
|
26528
|
+
"last_updated_by"
|
|
26529
|
+
],
|
|
26530
|
+
"title": "VoiceGroupProperties",
|
|
26531
|
+
"description": "Names of voice group fields supported for filtering/sorting on list endpoint."
|
|
26532
|
+
},
|
|
26533
|
+
"VoiceGroupResponse": {
|
|
26534
|
+
"properties": {
|
|
26535
|
+
"name": {
|
|
26536
|
+
"type": "string",
|
|
26537
|
+
"title": "Name",
|
|
26538
|
+
"description": "The name of the language group.",
|
|
25578
26539
|
"examples": [
|
|
25579
|
-
1
|
|
26540
|
+
"Call Center 1 Languages"
|
|
25580
26541
|
]
|
|
25581
26542
|
},
|
|
25582
|
-
"
|
|
26543
|
+
"description": {
|
|
25583
26544
|
"anyOf": [
|
|
25584
26545
|
{
|
|
25585
26546
|
"type": "string"
|
|
@@ -25588,50 +26549,53 @@
|
|
|
25588
26549
|
"type": "null"
|
|
25589
26550
|
}
|
|
25590
26551
|
],
|
|
25591
|
-
"title": "
|
|
25592
|
-
"description": "
|
|
25593
|
-
"examples": [
|
|
25594
|
-
"Updated to change which role was assigned"
|
|
25595
|
-
]
|
|
25596
|
-
},
|
|
25597
|
-
"id": {
|
|
25598
|
-
"type": "integer",
|
|
25599
|
-
"title": "Id",
|
|
25600
|
-
"description": "Internal ID of the user",
|
|
26552
|
+
"title": "Description",
|
|
26553
|
+
"description": "Description of the language group.",
|
|
25601
26554
|
"examples": [
|
|
25602
|
-
1
|
|
26555
|
+
"Languages spoken by operators at Call Center 1"
|
|
25603
26556
|
]
|
|
25604
26557
|
},
|
|
25605
|
-
"
|
|
25606
|
-
"
|
|
25607
|
-
|
|
25608
|
-
|
|
26558
|
+
"language_configs": {
|
|
26559
|
+
"items": {
|
|
26560
|
+
"$ref": "#/components/schemas/LanguageConfig"
|
|
26561
|
+
},
|
|
26562
|
+
"type": "array",
|
|
26563
|
+
"title": "Language Configs",
|
|
26564
|
+
"description": "Voice and DTMF configurations for each language in the group.",
|
|
25609
26565
|
"examples": [
|
|
25610
|
-
|
|
26566
|
+
[
|
|
26567
|
+
{
|
|
26568
|
+
"dtmf_code": 1,
|
|
26569
|
+
"language_code": "en-US",
|
|
26570
|
+
"voice_display_name": "Alloy",
|
|
26571
|
+
"voice_provider": "OpenAI"
|
|
26572
|
+
},
|
|
26573
|
+
{
|
|
26574
|
+
"dtmf_code": 2,
|
|
26575
|
+
"language_code": "es-US",
|
|
26576
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
26577
|
+
"voice_provider": "Google"
|
|
26578
|
+
}
|
|
26579
|
+
]
|
|
25611
26580
|
]
|
|
25612
26581
|
},
|
|
25613
|
-
"
|
|
26582
|
+
"skip_current_language_in_message": {
|
|
25614
26583
|
"type": "boolean",
|
|
25615
|
-
"title": "
|
|
25616
|
-
"description": "Whether
|
|
26584
|
+
"title": "Skip Current Language In Message",
|
|
26585
|
+
"description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
|
|
25617
26586
|
"examples": [
|
|
25618
26587
|
true
|
|
25619
26588
|
]
|
|
25620
26589
|
},
|
|
25621
|
-
"
|
|
25622
|
-
"
|
|
25623
|
-
"
|
|
26590
|
+
"id": {
|
|
26591
|
+
"type": "integer",
|
|
26592
|
+
"title": "Id",
|
|
26593
|
+
"description": "The ID of the language group to update.",
|
|
25624
26594
|
"examples": [
|
|
25625
|
-
|
|
26595
|
+
1
|
|
25626
26596
|
]
|
|
25627
26597
|
},
|
|
25628
|
-
"
|
|
25629
|
-
"type": "string",
|
|
25630
|
-
"format": "date-time",
|
|
25631
|
-
"title": "Last Updated",
|
|
25632
|
-
"description": "The timestamp of the most recent update to the user"
|
|
25633
|
-
},
|
|
25634
|
-
"last_updated_by": {
|
|
26598
|
+
"edit_comments": {
|
|
25635
26599
|
"anyOf": [
|
|
25636
26600
|
{
|
|
25637
26601
|
"type": "string"
|
|
@@ -25640,53 +26604,76 @@
|
|
|
25640
26604
|
"type": "null"
|
|
25641
26605
|
}
|
|
25642
26606
|
],
|
|
25643
|
-
"title": "
|
|
25644
|
-
"description": "
|
|
26607
|
+
"title": "Edit Comments",
|
|
26608
|
+
"description": "Comments for the most recent edit to the language group.",
|
|
25645
26609
|
"examples": [
|
|
25646
|
-
"
|
|
26610
|
+
"Added Spanish support."
|
|
25647
26611
|
]
|
|
25648
26612
|
},
|
|
25649
|
-
"
|
|
26613
|
+
"agents_info": {
|
|
25650
26614
|
"anyOf": [
|
|
25651
26615
|
{
|
|
25652
|
-
"
|
|
25653
|
-
|
|
26616
|
+
"items": {
|
|
26617
|
+
"$ref": "#/components/schemas/LanguageGroupAgentInfo"
|
|
26618
|
+
},
|
|
26619
|
+
"type": "array"
|
|
25654
26620
|
},
|
|
25655
26621
|
{
|
|
25656
26622
|
"type": "null"
|
|
25657
26623
|
}
|
|
25658
26624
|
],
|
|
25659
|
-
"title": "
|
|
25660
|
-
"description": "
|
|
26625
|
+
"title": "Agents Info",
|
|
26626
|
+
"description": "IDs and names of the agents linked to the language group",
|
|
25661
26627
|
"examples": [
|
|
25662
|
-
|
|
26628
|
+
[
|
|
26629
|
+
{
|
|
26630
|
+
"id": 1,
|
|
26631
|
+
"name": "Test Agent"
|
|
26632
|
+
}
|
|
26633
|
+
]
|
|
26634
|
+
]
|
|
26635
|
+
},
|
|
26636
|
+
"updated_at": {
|
|
26637
|
+
"type": "string",
|
|
26638
|
+
"format": "date-time",
|
|
26639
|
+
"title": "Updated At",
|
|
26640
|
+
"description": "Timestamp of the last update to the language group.",
|
|
26641
|
+
"examples": [
|
|
26642
|
+
"2024-01-01T00:00:00Z"
|
|
26643
|
+
]
|
|
26644
|
+
},
|
|
26645
|
+
"last_updated_by": {
|
|
26646
|
+
"type": "string",
|
|
26647
|
+
"title": "Last Updated By",
|
|
26648
|
+
"description": "Email of the user who last updated the language group.",
|
|
26649
|
+
"examples": [
|
|
26650
|
+
"user@mail.com"
|
|
25663
26651
|
]
|
|
25664
26652
|
}
|
|
25665
26653
|
},
|
|
25666
26654
|
"type": "object",
|
|
25667
26655
|
"required": [
|
|
25668
|
-
"
|
|
25669
|
-
"
|
|
26656
|
+
"name",
|
|
26657
|
+
"language_configs",
|
|
26658
|
+
"skip_current_language_in_message",
|
|
25670
26659
|
"id",
|
|
25671
|
-
"
|
|
25672
|
-
"
|
|
25673
|
-
"activity_status",
|
|
25674
|
-
"last_updated"
|
|
26660
|
+
"updated_at",
|
|
26661
|
+
"last_updated_by"
|
|
25675
26662
|
],
|
|
25676
|
-
"title": "
|
|
25677
|
-
"description": "
|
|
26663
|
+
"title": "VoiceGroupResponse",
|
|
26664
|
+
"description": "Response model for voice group operations.\nA voice group is a collection of language, voice, and DTMF configuration that can be\nlinked to an agent to define the languages and voices it supports. For more information, see\n[Console docs](https://docs.syllable.ai/Resources/VoiceGroups)."
|
|
25678
26665
|
},
|
|
25679
|
-
"
|
|
26666
|
+
"VoiceGroupUpdateRequest": {
|
|
25680
26667
|
"properties": {
|
|
25681
|
-
"
|
|
26668
|
+
"name": {
|
|
25682
26669
|
"type": "string",
|
|
25683
|
-
"title": "
|
|
25684
|
-
"description": "
|
|
26670
|
+
"title": "Name",
|
|
26671
|
+
"description": "The name of the language group.",
|
|
25685
26672
|
"examples": [
|
|
25686
|
-
"
|
|
26673
|
+
"Call Center 1 Languages"
|
|
25687
26674
|
]
|
|
25688
26675
|
},
|
|
25689
|
-
"
|
|
26676
|
+
"description": {
|
|
25690
26677
|
"anyOf": [
|
|
25691
26678
|
{
|
|
25692
26679
|
"type": "string"
|
|
@@ -25695,36 +26682,53 @@
|
|
|
25695
26682
|
"type": "null"
|
|
25696
26683
|
}
|
|
25697
26684
|
],
|
|
25698
|
-
"title": "
|
|
25699
|
-
"description": "
|
|
26685
|
+
"title": "Description",
|
|
26686
|
+
"description": "Description of the language group.",
|
|
25700
26687
|
"examples": [
|
|
25701
|
-
"
|
|
26688
|
+
"Languages spoken by operators at Call Center 1"
|
|
25702
26689
|
]
|
|
25703
26690
|
},
|
|
25704
|
-
"
|
|
25705
|
-
"
|
|
25706
|
-
|
|
25707
|
-
|
|
25708
|
-
|
|
25709
|
-
|
|
25710
|
-
|
|
25711
|
-
}
|
|
25712
|
-
],
|
|
25713
|
-
"title": "Last Name",
|
|
25714
|
-
"description": "Last name of the user",
|
|
26691
|
+
"language_configs": {
|
|
26692
|
+
"items": {
|
|
26693
|
+
"$ref": "#/components/schemas/LanguageConfig"
|
|
26694
|
+
},
|
|
26695
|
+
"type": "array",
|
|
26696
|
+
"title": "Language Configs",
|
|
26697
|
+
"description": "Voice and DTMF configurations for each language in the group.",
|
|
25715
26698
|
"examples": [
|
|
25716
|
-
|
|
26699
|
+
[
|
|
26700
|
+
{
|
|
26701
|
+
"dtmf_code": 1,
|
|
26702
|
+
"language_code": "en-US",
|
|
26703
|
+
"voice_display_name": "Alloy",
|
|
26704
|
+
"voice_provider": "OpenAI"
|
|
26705
|
+
},
|
|
26706
|
+
{
|
|
26707
|
+
"dtmf_code": 2,
|
|
26708
|
+
"language_code": "es-US",
|
|
26709
|
+
"voice_display_name": "es-US-Neural2-B",
|
|
26710
|
+
"voice_provider": "Google"
|
|
26711
|
+
}
|
|
26712
|
+
]
|
|
25717
26713
|
]
|
|
25718
26714
|
},
|
|
25719
|
-
"
|
|
26715
|
+
"skip_current_language_in_message": {
|
|
26716
|
+
"type": "boolean",
|
|
26717
|
+
"title": "Skip Current Language In Message",
|
|
26718
|
+
"description": "Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu.",
|
|
26719
|
+
"examples": [
|
|
26720
|
+
true
|
|
26721
|
+
]
|
|
26722
|
+
},
|
|
26723
|
+
"id": {
|
|
25720
26724
|
"type": "integer",
|
|
25721
|
-
"title": "
|
|
25722
|
-
"description": "ID of the
|
|
26725
|
+
"title": "Id",
|
|
26726
|
+
"description": "The ID of the language group to update.",
|
|
25723
26727
|
"examples": [
|
|
25724
26728
|
1
|
|
25725
26729
|
]
|
|
25726
26730
|
},
|
|
25727
|
-
"
|
|
26731
|
+
"edit_comments": {
|
|
25728
26732
|
"anyOf": [
|
|
25729
26733
|
{
|
|
25730
26734
|
"type": "string"
|
|
@@ -25733,73 +26737,22 @@
|
|
|
25733
26737
|
"type": "null"
|
|
25734
26738
|
}
|
|
25735
26739
|
],
|
|
25736
|
-
"title": "
|
|
25737
|
-
"description": "Comments for the most recent edit to the
|
|
26740
|
+
"title": "Edit Comments",
|
|
26741
|
+
"description": "Comments for the most recent edit to the language group.",
|
|
25738
26742
|
"examples": [
|
|
25739
|
-
"
|
|
26743
|
+
"Added Spanish support."
|
|
25740
26744
|
]
|
|
25741
26745
|
}
|
|
25742
26746
|
},
|
|
25743
26747
|
"type": "object",
|
|
25744
26748
|
"required": [
|
|
25745
|
-
"
|
|
25746
|
-
"
|
|
25747
|
-
|
|
25748
|
-
|
|
25749
|
-
"description": "Request model to update an existing user."
|
|
25750
|
-
},
|
|
25751
|
-
"ValidationError": {
|
|
25752
|
-
"properties": {
|
|
25753
|
-
"loc": {
|
|
25754
|
-
"items": {
|
|
25755
|
-
"anyOf": [
|
|
25756
|
-
{
|
|
25757
|
-
"type": "string"
|
|
25758
|
-
},
|
|
25759
|
-
{
|
|
25760
|
-
"type": "integer"
|
|
25761
|
-
}
|
|
25762
|
-
]
|
|
25763
|
-
},
|
|
25764
|
-
"type": "array",
|
|
25765
|
-
"title": "Location"
|
|
25766
|
-
},
|
|
25767
|
-
"msg": {
|
|
25768
|
-
"type": "string",
|
|
25769
|
-
"title": "Message"
|
|
25770
|
-
},
|
|
25771
|
-
"type": {
|
|
25772
|
-
"type": "string",
|
|
25773
|
-
"title": "Error Type"
|
|
25774
|
-
}
|
|
25775
|
-
},
|
|
25776
|
-
"type": "object",
|
|
25777
|
-
"required": [
|
|
25778
|
-
"loc",
|
|
25779
|
-
"msg",
|
|
25780
|
-
"type"
|
|
25781
|
-
],
|
|
25782
|
-
"title": "ValidationError"
|
|
25783
|
-
},
|
|
25784
|
-
"VoiceDisplayInfo": {
|
|
25785
|
-
"properties": {
|
|
25786
|
-
"display_name": {
|
|
25787
|
-
"type": "string",
|
|
25788
|
-
"title": "Display Name"
|
|
25789
|
-
},
|
|
25790
|
-
"provider": {
|
|
25791
|
-
"type": "string",
|
|
25792
|
-
"title": "Provider"
|
|
25793
|
-
}
|
|
25794
|
-
},
|
|
25795
|
-
"additionalProperties": false,
|
|
25796
|
-
"type": "object",
|
|
25797
|
-
"required": [
|
|
25798
|
-
"display_name",
|
|
25799
|
-
"provider"
|
|
26749
|
+
"name",
|
|
26750
|
+
"language_configs",
|
|
26751
|
+
"skip_current_language_in_message",
|
|
26752
|
+
"id"
|
|
25800
26753
|
],
|
|
25801
|
-
"title": "
|
|
25802
|
-
"description": "
|
|
26754
|
+
"title": "VoiceGroupUpdateRequest",
|
|
26755
|
+
"description": "Request model to update an existing voice group."
|
|
25803
26756
|
},
|
|
25804
26757
|
"VoiceSampleCreateRequest": {
|
|
25805
26758
|
"properties": {
|