freeclimb 4.4.3 → 4.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/Gemfile.lock +1 -1
- data/README.md +202 -202
- data/docs/SMSTenDLCCampaign.md +1 -1
- data/docs/TranscribeUtterance.md +28 -0
- data/docs/TranscribeUtteranceRecord.md +22 -0
- data/lib/freeclimb/models/transcribe_utterance.rb +291 -0
- data/lib/freeclimb/models/transcribe_utterance_record.rb +293 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +2 -0
- data/openapi.json +347 -72
- data/spec/api/default_api_spec.rb +13 -1
- data/spec/models/account_request_spec.rb +1 -0
- data/spec/models/account_result_spec.rb +3 -0
- data/spec/models/account_status_spec.rb +1 -0
- data/spec/models/account_type_spec.rb +1 -0
- data/spec/models/add_to_conference_spec.rb +1 -0
- data/spec/models/answered_by_spec.rb +1 -0
- data/spec/models/application_list_spec.rb +1 -0
- data/spec/models/application_request_spec.rb +1 -0
- data/spec/models/application_result_spec.rb +1 -0
- data/spec/models/available_number_list_spec.rb +1 -0
- data/spec/models/available_number_spec.rb +1 -0
- data/spec/models/buy_incoming_number_request_spec.rb +1 -0
- data/spec/models/call_direction_spec.rb +1 -0
- data/spec/models/call_list_spec.rb +1 -0
- data/spec/models/call_result_spec.rb +4 -0
- data/spec/models/call_status_spec.rb +1 -0
- data/spec/models/capabilities_spec.rb +1 -0
- data/spec/models/conference_list_spec.rb +1 -0
- data/spec/models/conference_participant_list_spec.rb +1 -0
- data/spec/models/conference_participant_result_spec.rb +1 -0
- data/spec/models/conference_result_spec.rb +3 -0
- data/spec/models/conference_status_spec.rb +1 -0
- data/spec/models/create_conference_request_spec.rb +2 -0
- data/spec/models/create_conference_spec.rb +2 -0
- data/spec/models/dequeue_spec.rb +1 -0
- data/spec/models/enqueue_spec.rb +1 -0
- data/spec/models/filter_logs_request_spec.rb +1 -0
- data/spec/models/get_digits_spec.rb +1 -0
- data/spec/models/get_speech_reason_spec.rb +1 -0
- data/spec/models/get_speech_spec.rb +2 -0
- data/spec/models/grammar_file_built_in_spec.rb +1 -0
- data/spec/models/grammar_type_spec.rb +1 -0
- data/spec/models/hangup_spec.rb +1 -0
- data/spec/models/if_machine_spec.rb +1 -0
- data/spec/models/incoming_number_list_spec.rb +1 -0
- data/spec/models/incoming_number_request_spec.rb +1 -0
- data/spec/models/incoming_number_result_spec.rb +1 -0
- data/spec/models/language_spec.rb +1 -0
- data/spec/models/log_level_spec.rb +1 -0
- data/spec/models/log_list_spec.rb +1 -0
- data/spec/models/log_result_spec.rb +2 -0
- data/spec/models/machine_type_spec.rb +1 -0
- data/spec/models/make_call_request_spec.rb +1 -0
- data/spec/models/message_direction_spec.rb +1 -0
- data/spec/models/message_request_spec.rb +1 -0
- data/spec/models/message_result_spec.rb +2 -0
- data/spec/models/message_status_spec.rb +1 -0
- data/spec/models/messages_list_spec.rb +1 -0
- data/spec/models/mutable_resource_model_spec.rb +1 -0
- data/spec/models/out_dial_spec.rb +2 -0
- data/spec/models/pagination_model_spec.rb +1 -0
- data/spec/models/park_spec.rb +1 -0
- data/spec/models/pause_spec.rb +1 -0
- data/spec/models/percl_command_spec.rb +1 -0
- data/spec/models/percl_script_spec.rb +1 -0
- data/spec/models/play_beep_spec.rb +1 -0
- data/spec/models/play_early_media_spec.rb +1 -0
- data/spec/models/play_spec.rb +1 -0
- data/spec/models/queue_list_spec.rb +1 -0
- data/spec/models/queue_member_list_spec.rb +1 -0
- data/spec/models/queue_member_spec.rb +1 -0
- data/spec/models/queue_request_spec.rb +1 -0
- data/spec/models/queue_result_spec.rb +1 -0
- data/spec/models/queue_result_status_spec.rb +1 -0
- data/spec/models/record_utterance_spec.rb +1 -0
- data/spec/models/record_utterance_term_reason_spec.rb +1 -0
- data/spec/models/recording_list_spec.rb +1 -0
- data/spec/models/recording_result_spec.rb +1 -0
- data/spec/models/redirect_spec.rb +1 -0
- data/spec/models/reject_spec.rb +1 -0
- data/spec/models/remove_from_conference_spec.rb +1 -0
- data/spec/models/request_type_spec.rb +1 -0
- data/spec/models/say_spec.rb +1 -0
- data/spec/models/send_digits_spec.rb +1 -0
- data/spec/models/set_listen_spec.rb +1 -0
- data/spec/models/set_talk_spec.rb +1 -0
- data/spec/models/sms_spec.rb +1 -0
- data/spec/models/sms_ten_dlc_brand_spec.rb +120 -73
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +1 -0
- data/spec/models/sms_ten_dlc_campaign_spec.rb +72 -42
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +1 -0
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +43 -21
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +91 -48
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +1 -0
- data/spec/models/start_record_call_spec.rb +1 -0
- data/spec/models/terminate_conference_spec.rb +1 -0
- data/spec/models/transcribe_utterance_record_spec.rb +222 -0
- data/spec/models/transcribe_utterance_spec.rb +380 -0
- data/spec/models/unpark_spec.rb +1 -0
- data/spec/models/update_call_request_spec.rb +2 -0
- data/spec/models/update_call_request_status_spec.rb +1 -0
- data/spec/models/update_conference_participant_request_spec.rb +1 -0
- data/spec/models/update_conference_request_spec.rb +3 -0
- data/spec/models/update_conference_request_status_spec.rb +1 -0
- metadata +10 -2
data/openapi.json
CHANGED
@@ -83,8 +83,16 @@
|
|
83
83
|
"schemas": {
|
84
84
|
"AccountStatus": {
|
85
85
|
"type": "string",
|
86
|
-
"enum": [
|
87
|
-
|
86
|
+
"enum": [
|
87
|
+
"closed",
|
88
|
+
"suspended",
|
89
|
+
"active"
|
90
|
+
],
|
91
|
+
"x-enum-varnames": [
|
92
|
+
"CLOSED",
|
93
|
+
"SUSPENDED",
|
94
|
+
"ACTIVE"
|
95
|
+
],
|
88
96
|
"x-enum": true,
|
89
97
|
"description": "The status of this account. It is one of: active, suspended, or closed.",
|
90
98
|
"nullable": true
|
@@ -92,24 +100,44 @@
|
|
92
100
|
"AccountType": {
|
93
101
|
"type": "string",
|
94
102
|
"description": "The type of this account. It is one of: trial or full.",
|
95
|
-
"enum": [
|
103
|
+
"enum": [
|
104
|
+
"trial",
|
105
|
+
"full"
|
106
|
+
],
|
96
107
|
"x-enum": true,
|
97
|
-
"x-enum-varnames": [
|
108
|
+
"x-enum-varnames": [
|
109
|
+
"TRIAL",
|
110
|
+
"FULL"
|
111
|
+
],
|
98
112
|
"nullable": true
|
99
113
|
},
|
100
114
|
"AnsweredBy": {
|
101
115
|
"type": "string",
|
102
116
|
"nullable": true,
|
103
|
-
"enum": [
|
104
|
-
|
117
|
+
"enum": [
|
118
|
+
"human",
|
119
|
+
"machine"
|
120
|
+
],
|
121
|
+
"x-enum-varnames": [
|
122
|
+
"HUMAN",
|
123
|
+
"MACHINE"
|
124
|
+
],
|
105
125
|
"x-enum": true,
|
106
126
|
"description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
|
107
127
|
},
|
108
128
|
"CallDirection": {
|
109
129
|
"type": "string",
|
110
130
|
"nullable": true,
|
111
|
-
"enum": [
|
112
|
-
|
131
|
+
"enum": [
|
132
|
+
"inbound",
|
133
|
+
"outboundAPI",
|
134
|
+
"outboundDial"
|
135
|
+
],
|
136
|
+
"x-enum-varnames": [
|
137
|
+
"INBOUND",
|
138
|
+
"OUTBOUND_API",
|
139
|
+
"OUTBOUND_DIAL"
|
140
|
+
],
|
113
141
|
"x-enum": true,
|
114
142
|
"description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command."
|
115
143
|
},
|
@@ -142,8 +170,18 @@
|
|
142
170
|
"ConferenceStatus": {
|
143
171
|
"type": "string",
|
144
172
|
"nullable": true,
|
145
|
-
"enum": [
|
146
|
-
|
173
|
+
"enum": [
|
174
|
+
"empty",
|
175
|
+
"populated",
|
176
|
+
"inProgress",
|
177
|
+
"terminated"
|
178
|
+
],
|
179
|
+
"x-enum-varnames": [
|
180
|
+
"EMPTY",
|
181
|
+
"POPULATED",
|
182
|
+
"IN_PROGRESS",
|
183
|
+
"TERMINATED"
|
184
|
+
],
|
147
185
|
"x-enum": true,
|
148
186
|
"description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
|
149
187
|
},
|
@@ -207,16 +245,28 @@
|
|
207
245
|
},
|
208
246
|
"GrammarType": {
|
209
247
|
"type": "string",
|
210
|
-
"enum": [
|
248
|
+
"enum": [
|
249
|
+
"URL",
|
250
|
+
"BUILTIN"
|
251
|
+
],
|
211
252
|
"nullable": true,
|
212
|
-
"x-enum-varnames": [
|
253
|
+
"x-enum-varnames": [
|
254
|
+
"URL",
|
255
|
+
"BUILT_IN"
|
256
|
+
],
|
213
257
|
"x-enum": true,
|
214
258
|
"description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
|
215
259
|
},
|
216
260
|
"IfMachine": {
|
217
261
|
"type": "string",
|
218
|
-
"enum": [
|
219
|
-
|
262
|
+
"enum": [
|
263
|
+
"redirect",
|
264
|
+
"hangup"
|
265
|
+
],
|
266
|
+
"x-enum-varnames": [
|
267
|
+
"REDIRECT",
|
268
|
+
"HANGUP"
|
269
|
+
],
|
220
270
|
"x-enum": true,
|
221
271
|
"description": "Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked."
|
222
272
|
},
|
@@ -282,22 +332,42 @@
|
|
282
332
|
},
|
283
333
|
"LogLevel": {
|
284
334
|
"type": "string",
|
285
|
-
"enum": [
|
335
|
+
"enum": [
|
336
|
+
"info",
|
337
|
+
"warning",
|
338
|
+
"error"
|
339
|
+
],
|
286
340
|
"nullable": true,
|
287
|
-
"x-enum-varnames": [
|
341
|
+
"x-enum-varnames": [
|
342
|
+
"INFO",
|
343
|
+
"WARNING",
|
344
|
+
"ERROR"
|
345
|
+
],
|
288
346
|
"x-enum": true,
|
289
347
|
"description": "Level of the log. Possible values are info, warning, and error."
|
290
348
|
},
|
291
349
|
"MachineType": {
|
292
350
|
"type": "string",
|
293
|
-
"enum": [
|
294
|
-
|
351
|
+
"enum": [
|
352
|
+
"answeringMachine",
|
353
|
+
"faxMachine"
|
354
|
+
],
|
355
|
+
"x-enum-varnames": [
|
356
|
+
"ANSWERING_MACHINE",
|
357
|
+
"FAX_MACHINE"
|
358
|
+
],
|
295
359
|
"x-enum": true
|
296
360
|
},
|
297
361
|
"MessageDirection": {
|
298
362
|
"type": "string",
|
299
|
-
"enum": [
|
300
|
-
|
363
|
+
"enum": [
|
364
|
+
"inbound",
|
365
|
+
"outbound"
|
366
|
+
],
|
367
|
+
"x-enum-varnames": [
|
368
|
+
"INBOUND",
|
369
|
+
"OUTBOUND"
|
370
|
+
],
|
301
371
|
"x-enum": true
|
302
372
|
},
|
303
373
|
"MessageStatus": {
|
@@ -335,8 +405,18 @@
|
|
335
405
|
"PlayBeep": {
|
336
406
|
"type": "string",
|
337
407
|
"nullable": true,
|
338
|
-
"enum": [
|
339
|
-
|
408
|
+
"enum": [
|
409
|
+
"always",
|
410
|
+
"never",
|
411
|
+
"entryOnly",
|
412
|
+
"exitOnly"
|
413
|
+
],
|
414
|
+
"x-enum-varnames": [
|
415
|
+
"ALWAYS",
|
416
|
+
"NEVER",
|
417
|
+
"ENTRY_ONLY",
|
418
|
+
"EXIT_ONLY"
|
419
|
+
],
|
340
420
|
"x-enum": true,
|
341
421
|
"description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
|
342
422
|
"default": "always",
|
@@ -344,14 +424,34 @@
|
|
344
424
|
},
|
345
425
|
"QueueResultStatus": {
|
346
426
|
"type": "string",
|
347
|
-
"enum": [
|
348
|
-
|
427
|
+
"enum": [
|
428
|
+
"queueFull",
|
429
|
+
"dequeued",
|
430
|
+
"hangup",
|
431
|
+
"systemError"
|
432
|
+
],
|
433
|
+
"x-enum-varnames": [
|
434
|
+
"QUEUE_FULL",
|
435
|
+
"DEQUEUED",
|
436
|
+
"HANGUP",
|
437
|
+
"SYSTEM_ERROR"
|
438
|
+
],
|
349
439
|
"x-enum": true
|
350
440
|
},
|
351
441
|
"RecordUtteranceTermReason": {
|
352
442
|
"type": "string",
|
353
|
-
"enum": [
|
354
|
-
|
443
|
+
"enum": [
|
444
|
+
"finishKey",
|
445
|
+
"timeout",
|
446
|
+
"hangup",
|
447
|
+
"maxLength"
|
448
|
+
],
|
449
|
+
"x-enum-varnames": [
|
450
|
+
"FINISH_KEY",
|
451
|
+
"TIMEOUT",
|
452
|
+
"HANGUP",
|
453
|
+
"MAX_LENGTH"
|
454
|
+
],
|
355
455
|
"x-enum": true
|
356
456
|
},
|
357
457
|
"RequestType": {
|
@@ -410,15 +510,27 @@
|
|
410
510
|
},
|
411
511
|
"UpdateCallRequestStatus": {
|
412
512
|
"type": "string",
|
413
|
-
"enum": [
|
414
|
-
|
513
|
+
"enum": [
|
514
|
+
"canceled",
|
515
|
+
"completed"
|
516
|
+
],
|
517
|
+
"x-enum-varnames": [
|
518
|
+
"CANCELED",
|
519
|
+
"COMPLETED"
|
520
|
+
],
|
415
521
|
"x-enum": true,
|
416
522
|
"description": "Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress."
|
417
523
|
},
|
418
524
|
"UpdateConferenceRequestStatus": {
|
419
525
|
"type": "string",
|
420
|
-
"enum": [
|
421
|
-
|
526
|
+
"enum": [
|
527
|
+
"empty",
|
528
|
+
"terminated"
|
529
|
+
],
|
530
|
+
"x-enum-varnames": [
|
531
|
+
"EMPTY",
|
532
|
+
"TERMINATED"
|
533
|
+
],
|
422
534
|
"x-enum": true,
|
423
535
|
"description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
|
424
536
|
},
|
@@ -486,7 +598,9 @@
|
|
486
598
|
},
|
487
599
|
{
|
488
600
|
"type": "object",
|
489
|
-
"required": [
|
601
|
+
"required": [
|
602
|
+
"conferenceId"
|
603
|
+
],
|
490
604
|
"properties": {
|
491
605
|
"allowCallControl": {
|
492
606
|
"description": "If `true`, Call control will be enabled for this Participant's Call leg.",
|
@@ -542,7 +656,9 @@
|
|
542
656
|
},
|
543
657
|
{
|
544
658
|
"type": "object",
|
545
|
-
"required": [
|
659
|
+
"required": [
|
660
|
+
"actionUrl"
|
661
|
+
],
|
546
662
|
"properties": {
|
547
663
|
"actionUrl": {
|
548
664
|
"description": " This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. ",
|
@@ -595,7 +711,11 @@
|
|
595
711
|
},
|
596
712
|
{
|
597
713
|
"type": "object",
|
598
|
-
"required": [
|
714
|
+
"required": [
|
715
|
+
"queueId",
|
716
|
+
"waitUrl",
|
717
|
+
"actionUrl"
|
718
|
+
],
|
599
719
|
"properties": {
|
600
720
|
"actionUrl": {
|
601
721
|
"description": "A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.",
|
@@ -629,7 +749,9 @@
|
|
629
749
|
},
|
630
750
|
{
|
631
751
|
"type": "object",
|
632
|
-
"required": [
|
752
|
+
"required": [
|
753
|
+
"actionUrl"
|
754
|
+
],
|
633
755
|
"properties": {
|
634
756
|
"actionUrl": {
|
635
757
|
"description": "When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.",
|
@@ -685,7 +807,10 @@
|
|
685
807
|
},
|
686
808
|
{
|
687
809
|
"type": "object",
|
688
|
-
"required": [
|
810
|
+
"required": [
|
811
|
+
"actionUrl",
|
812
|
+
"grammarFile"
|
813
|
+
],
|
689
814
|
"properties": {
|
690
815
|
"actionUrl": {
|
691
816
|
"description": "When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.",
|
@@ -838,7 +963,10 @@
|
|
838
963
|
},
|
839
964
|
{
|
840
965
|
"type": "object",
|
841
|
-
"required": [
|
966
|
+
"required": [
|
967
|
+
"waitUrl",
|
968
|
+
"actionUrl"
|
969
|
+
],
|
842
970
|
"properties": {
|
843
971
|
"waitUrl": {
|
844
972
|
"description": "Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely.",
|
@@ -867,7 +995,9 @@
|
|
867
995
|
},
|
868
996
|
{
|
869
997
|
"type": "object",
|
870
|
-
"required": [
|
998
|
+
"required": [
|
999
|
+
"length"
|
1000
|
+
],
|
871
1001
|
"properties": {
|
872
1002
|
"length": {
|
873
1003
|
"description": "Length in milliseconds. FreeClimb will wait silently before continuing on.",
|
@@ -885,7 +1015,9 @@
|
|
885
1015
|
"$ref": "#/components/schemas/PerclCommand"
|
886
1016
|
},
|
887
1017
|
{
|
888
|
-
"required": [
|
1018
|
+
"required": [
|
1019
|
+
"file"
|
1020
|
+
],
|
889
1021
|
"type": "object",
|
890
1022
|
"properties": {
|
891
1023
|
"file": {
|
@@ -916,7 +1048,9 @@
|
|
916
1048
|
"$ref": "#/components/schemas/PerclCommand"
|
917
1049
|
},
|
918
1050
|
{
|
919
|
-
"required": [
|
1051
|
+
"required": [
|
1052
|
+
"file"
|
1053
|
+
],
|
920
1054
|
"type": "object",
|
921
1055
|
"properties": {
|
922
1056
|
"file": {
|
@@ -936,7 +1070,9 @@
|
|
936
1070
|
"x-is-uri": true
|
937
1071
|
},
|
938
1072
|
{
|
939
|
-
"required": [
|
1073
|
+
"required": [
|
1074
|
+
"actionUrl"
|
1075
|
+
],
|
940
1076
|
"type": "object",
|
941
1077
|
"properties": {
|
942
1078
|
"actionUrl": {
|
@@ -981,7 +1117,9 @@
|
|
981
1117
|
"x-is-uri": true
|
982
1118
|
},
|
983
1119
|
{
|
984
|
-
"required": [
|
1120
|
+
"required": [
|
1121
|
+
"actionUrl"
|
1122
|
+
],
|
985
1123
|
"type": "object",
|
986
1124
|
"properties": {
|
987
1125
|
"actionUrl": {
|
@@ -1019,7 +1157,9 @@
|
|
1019
1157
|
"$ref": "#/components/schemas/PerclCommand"
|
1020
1158
|
},
|
1021
1159
|
{
|
1022
|
-
"required": [
|
1160
|
+
"required": [
|
1161
|
+
"callId"
|
1162
|
+
],
|
1023
1163
|
"type": "object",
|
1024
1164
|
"properties": {
|
1025
1165
|
"callId": {
|
@@ -1038,7 +1178,9 @@
|
|
1038
1178
|
"$ref": "#/components/schemas/PerclCommand"
|
1039
1179
|
},
|
1040
1180
|
{
|
1041
|
-
"required": [
|
1181
|
+
"required": [
|
1182
|
+
"text"
|
1183
|
+
],
|
1042
1184
|
"type": "object",
|
1043
1185
|
"properties": {
|
1044
1186
|
"text": {
|
@@ -1074,7 +1216,9 @@
|
|
1074
1216
|
"$ref": "#/components/schemas/PerclCommand"
|
1075
1217
|
},
|
1076
1218
|
{
|
1077
|
-
"required": [
|
1219
|
+
"required": [
|
1220
|
+
"digits"
|
1221
|
+
],
|
1078
1222
|
"type": "object",
|
1079
1223
|
"properties": {
|
1080
1224
|
"digits": {
|
@@ -1101,7 +1245,9 @@
|
|
1101
1245
|
"$ref": "#/components/schemas/PerclCommand"
|
1102
1246
|
},
|
1103
1247
|
{
|
1104
|
-
"required": [
|
1248
|
+
"required": [
|
1249
|
+
"callId"
|
1250
|
+
],
|
1105
1251
|
"type": "object",
|
1106
1252
|
"properties": {
|
1107
1253
|
"callId": {
|
@@ -1124,7 +1270,9 @@
|
|
1124
1270
|
"$ref": "#/components/schemas/PerclCommand"
|
1125
1271
|
},
|
1126
1272
|
{
|
1127
|
-
"required": [
|
1273
|
+
"required": [
|
1274
|
+
"callId"
|
1275
|
+
],
|
1128
1276
|
"type": "object",
|
1129
1277
|
"properties": {
|
1130
1278
|
"callId": {
|
@@ -1147,7 +1295,11 @@
|
|
1147
1295
|
"$ref": "#/components/schemas/PerclCommand"
|
1148
1296
|
},
|
1149
1297
|
{
|
1150
|
-
"required": [
|
1298
|
+
"required": [
|
1299
|
+
"to",
|
1300
|
+
"from",
|
1301
|
+
"text"
|
1302
|
+
],
|
1151
1303
|
"type": "object",
|
1152
1304
|
"properties": {
|
1153
1305
|
"to": {
|
@@ -1191,7 +1343,9 @@
|
|
1191
1343
|
"$ref": "#/components/schemas/PerclCommand"
|
1192
1344
|
},
|
1193
1345
|
{
|
1194
|
-
"required": [
|
1346
|
+
"required": [
|
1347
|
+
"conferenceId"
|
1348
|
+
],
|
1195
1349
|
"type": "object",
|
1196
1350
|
"properties": {
|
1197
1351
|
"conferenceId": {
|
@@ -1279,7 +1433,13 @@
|
|
1279
1433
|
"Capabilities": {
|
1280
1434
|
"description": "Details for which features this number may be used.",
|
1281
1435
|
"type": "object",
|
1282
|
-
"required": [
|
1436
|
+
"required": [
|
1437
|
+
"voice",
|
1438
|
+
"sms",
|
1439
|
+
"tollFree",
|
1440
|
+
"tenDLC",
|
1441
|
+
"shortCode"
|
1442
|
+
],
|
1283
1443
|
"x-is-object": true,
|
1284
1444
|
"properties": {
|
1285
1445
|
"voice": {
|
@@ -1653,7 +1813,9 @@
|
|
1653
1813
|
},
|
1654
1814
|
"BuyIncomingNumberRequest": {
|
1655
1815
|
"type": "object",
|
1656
|
-
"required": [
|
1816
|
+
"required": [
|
1817
|
+
"phoneNumber"
|
1818
|
+
],
|
1657
1819
|
"properties": {
|
1658
1820
|
"phoneNumber": {
|
1659
1821
|
"type": "string",
|
@@ -1752,7 +1914,9 @@
|
|
1752
1914
|
},
|
1753
1915
|
"UpdateCallRequest": {
|
1754
1916
|
"type": "object",
|
1755
|
-
"required": [
|
1917
|
+
"required": [
|
1918
|
+
"status"
|
1919
|
+
],
|
1756
1920
|
"properties": {
|
1757
1921
|
"status": {
|
1758
1922
|
"$ref": "#/components/schemas/UpdateCallRequestStatus"
|
@@ -1761,7 +1925,10 @@
|
|
1761
1925
|
},
|
1762
1926
|
"MakeCallRequest": {
|
1763
1927
|
"type": "object",
|
1764
|
-
"required": [
|
1928
|
+
"required": [
|
1929
|
+
"from",
|
1930
|
+
"to"
|
1931
|
+
],
|
1765
1932
|
"properties": {
|
1766
1933
|
"from": {
|
1767
1934
|
"type": "string",
|
@@ -2029,7 +2196,11 @@
|
|
2029
2196
|
},
|
2030
2197
|
{
|
2031
2198
|
"type": "object",
|
2032
|
-
"required": [
|
2199
|
+
"required": [
|
2200
|
+
"from",
|
2201
|
+
"to",
|
2202
|
+
"text"
|
2203
|
+
],
|
2033
2204
|
"properties": {
|
2034
2205
|
"from": {
|
2035
2206
|
"type": "string",
|
@@ -2388,7 +2559,9 @@
|
|
2388
2559
|
},
|
2389
2560
|
"FilterLogsRequest": {
|
2390
2561
|
"type": "object",
|
2391
|
-
"required": [
|
2562
|
+
"required": [
|
2563
|
+
"pql"
|
2564
|
+
],
|
2392
2565
|
"properties": {
|
2393
2566
|
"pql": {
|
2394
2567
|
"type": "string",
|
@@ -2443,7 +2616,6 @@
|
|
2443
2616
|
},
|
2444
2617
|
"resellerId": {
|
2445
2618
|
"maxLength": 8,
|
2446
|
-
"x-max-length-8": true,
|
2447
2619
|
"type": "string",
|
2448
2620
|
"nullable": true,
|
2449
2621
|
"description": "Alphanumeric identifier of the reseller that you want to associate with this campaign."
|
@@ -2452,8 +2624,14 @@
|
|
2452
2624
|
"type": "string",
|
2453
2625
|
"x-has-writer": true,
|
2454
2626
|
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2455
|
-
"enum": [
|
2456
|
-
|
2627
|
+
"enum": [
|
2628
|
+
"ACTIVE",
|
2629
|
+
"EXPIRED"
|
2630
|
+
],
|
2631
|
+
"x-enum-varnames": [
|
2632
|
+
"ACTIVE",
|
2633
|
+
"EXPIRED"
|
2634
|
+
]
|
2457
2635
|
},
|
2458
2636
|
"createDate": {
|
2459
2637
|
"type": "string",
|
@@ -2474,7 +2652,6 @@
|
|
2474
2652
|
},
|
2475
2653
|
"brandId": {
|
2476
2654
|
"maxLength": 8,
|
2477
|
-
"x-max-length-8": true,
|
2478
2655
|
"type": "string",
|
2479
2656
|
"description": "Alphanumeric identifier of the brand associated with this campaign."
|
2480
2657
|
},
|
@@ -2654,7 +2831,12 @@
|
|
2654
2831
|
]
|
2655
2832
|
},
|
2656
2833
|
"SMSTenDLCPartnerCampaign": {
|
2657
|
-
"required": [
|
2834
|
+
"required": [
|
2835
|
+
"brandId",
|
2836
|
+
"campaignId",
|
2837
|
+
"description",
|
2838
|
+
"usecase"
|
2839
|
+
],
|
2658
2840
|
"type": "object",
|
2659
2841
|
"properties": {
|
2660
2842
|
"accountId": {
|
@@ -2670,8 +2852,14 @@
|
|
2670
2852
|
"type": "string",
|
2671
2853
|
"x-has-writer": true,
|
2672
2854
|
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2673
|
-
"enum": [
|
2674
|
-
|
2855
|
+
"enum": [
|
2856
|
+
"ACTIVE",
|
2857
|
+
"EXPIRED"
|
2858
|
+
],
|
2859
|
+
"x-enum-varnames": [
|
2860
|
+
"ACTIVE",
|
2861
|
+
"EXPIRED"
|
2862
|
+
]
|
2675
2863
|
},
|
2676
2864
|
"createDate": {
|
2677
2865
|
"type": "string",
|
@@ -2681,7 +2869,6 @@
|
|
2681
2869
|
},
|
2682
2870
|
"brandId": {
|
2683
2871
|
"maxLength": 8,
|
2684
|
-
"x-max-length-8": true,
|
2685
2872
|
"type": "string",
|
2686
2873
|
"description": "Alphanumeric identifier of the brand associated with this campaign."
|
2687
2874
|
},
|
@@ -2851,7 +3038,10 @@
|
|
2851
3038
|
}
|
2852
3039
|
},
|
2853
3040
|
"SMSTenDLCPartnerCampaignBrand": {
|
2854
|
-
"required": [
|
3041
|
+
"required": [
|
3042
|
+
"email",
|
3043
|
+
"phone"
|
3044
|
+
],
|
2855
3045
|
"type": "object",
|
2856
3046
|
"x-is-object": true,
|
2857
3047
|
"properties": {
|
@@ -3025,8 +3215,7 @@
|
|
3025
3215
|
"maxLength": 2,
|
3026
3216
|
"type": "string",
|
3027
3217
|
"description": "ISO2 2 characters country code. Example: US - United States",
|
3028
|
-
"example": "US"
|
3029
|
-
"x-max-length-2": true
|
3218
|
+
"example": "US"
|
3030
3219
|
},
|
3031
3220
|
"phone": {
|
3032
3221
|
"maxLength": 20,
|
@@ -3054,14 +3243,12 @@
|
|
3054
3243
|
},
|
3055
3244
|
"postalCode": {
|
3056
3245
|
"maxLength": 10,
|
3057
|
-
"x-max-length-10": true,
|
3058
3246
|
"type": "string",
|
3059
3247
|
"description": "Postal codes. Use 5 digit zipcode for United States",
|
3060
3248
|
"example": "10001"
|
3061
3249
|
},
|
3062
3250
|
"country": {
|
3063
3251
|
"maxLength": 2,
|
3064
|
-
"x-max-length-2": true,
|
3065
3252
|
"type": "string",
|
3066
3253
|
"description": "ISO2 2 characters country code. Example: US - United States",
|
3067
3254
|
"example": "US"
|
@@ -3073,7 +3260,6 @@
|
|
3073
3260
|
},
|
3074
3261
|
"stockSymbol": {
|
3075
3262
|
"maxLength": 10,
|
3076
|
-
"x-max-length-10": true,
|
3077
3263
|
"type": "string",
|
3078
3264
|
"description": "(Required for public company) stock symbol.",
|
3079
3265
|
"example": "ABC"
|
@@ -3185,8 +3371,18 @@
|
|
3185
3371
|
"altBusinessIdType": {
|
3186
3372
|
"type": "string",
|
3187
3373
|
"x-has-writer": true,
|
3188
|
-
"enum": [
|
3189
|
-
|
3374
|
+
"enum": [
|
3375
|
+
"NONE",
|
3376
|
+
"DUNS",
|
3377
|
+
"GIIN",
|
3378
|
+
"LEI"
|
3379
|
+
],
|
3380
|
+
"x-enum-varnames": [
|
3381
|
+
"NONE",
|
3382
|
+
"DUNS",
|
3383
|
+
"GIIN",
|
3384
|
+
"LEI"
|
3385
|
+
],
|
3190
3386
|
"description": "The type of the Alternative business identifier"
|
3191
3387
|
},
|
3192
3388
|
"universalEin": {
|
@@ -3269,6 +3465,79 @@
|
|
3269
3465
|
"identityStatus": "VERIFIED",
|
3270
3466
|
"createDate": "2022-07-01T20:29:23Z"
|
3271
3467
|
}
|
3468
|
+
},
|
3469
|
+
"TranscribeUtterance": {
|
3470
|
+
"title": "TranscribeUtterance",
|
3471
|
+
"x-stoplight": {
|
3472
|
+
"id": "u509r3zqc38ze"
|
3473
|
+
},
|
3474
|
+
"type": "object",
|
3475
|
+
"description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
|
3476
|
+
"properties": {
|
3477
|
+
"actionUrl": {
|
3478
|
+
"type": "string"
|
3479
|
+
},
|
3480
|
+
"playBeep": {
|
3481
|
+
"type": "boolean",
|
3482
|
+
"default": false
|
3483
|
+
},
|
3484
|
+
"record": {
|
3485
|
+
"type": "object",
|
3486
|
+
"properties": {
|
3487
|
+
"saveRecording": {
|
3488
|
+
"type": "boolean",
|
3489
|
+
"default": false
|
3490
|
+
},
|
3491
|
+
"maxLengthSec": {
|
3492
|
+
"type": "integer",
|
3493
|
+
"minimum": 1,
|
3494
|
+
"maximum": 60,
|
3495
|
+
"default": 60
|
3496
|
+
},
|
3497
|
+
"rcrdTerminationSilenceTimeMs": {
|
3498
|
+
"type": "integer",
|
3499
|
+
"exclusiveMinimum": true,
|
3500
|
+
"minimum": 0,
|
3501
|
+
"maximum": 3000
|
3502
|
+
}
|
3503
|
+
}
|
3504
|
+
},
|
3505
|
+
"privacyForLogging": {
|
3506
|
+
"type": "boolean",
|
3507
|
+
"default": false
|
3508
|
+
},
|
3509
|
+
"privacyForRecording": {
|
3510
|
+
"type": "boolean",
|
3511
|
+
"default": false
|
3512
|
+
},
|
3513
|
+
"prompts": {
|
3514
|
+
"type": "array",
|
3515
|
+
"items": {}
|
3516
|
+
}
|
3517
|
+
},
|
3518
|
+
"required": [
|
3519
|
+
"actionUrl"
|
3520
|
+
],
|
3521
|
+
"x-examples": {
|
3522
|
+
"Example 1": {
|
3523
|
+
"TranscribeUtterance": {
|
3524
|
+
"actionUrl": "http://foo.vail/handleTranscription",
|
3525
|
+
"record": {
|
3526
|
+
"maxLengthSec": 60,
|
3527
|
+
"saveRecording": true,
|
3528
|
+
"rcrdTerminationSilenceTimeMs": 2000
|
3529
|
+
},
|
3530
|
+
"playBeep": true,
|
3531
|
+
"prompts": [
|
3532
|
+
{
|
3533
|
+
"Play": {
|
3534
|
+
"file": "http://dplutil01.vail/~user/prompts/please-record-greeting.wav"
|
3535
|
+
}
|
3536
|
+
}
|
3537
|
+
]
|
3538
|
+
}
|
3539
|
+
}
|
3540
|
+
}
|
3272
3541
|
}
|
3273
3542
|
}
|
3274
3543
|
},
|
@@ -5555,5 +5824,11 @@
|
|
5555
5824
|
"x-explorer-enabled": true,
|
5556
5825
|
"x-proxy-enabled": true,
|
5557
5826
|
"x-samples-enabled": false,
|
5558
|
-
"x-samples-languages": [
|
5559
|
-
|
5827
|
+
"x-samples-languages": [
|
5828
|
+
"curl",
|
5829
|
+
"node",
|
5830
|
+
"ruby",
|
5831
|
+
"javascript",
|
5832
|
+
"python"
|
5833
|
+
]
|
5834
|
+
}
|