freeclimb 4.6.0 → 4.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/Gemfile.lock +1 -1
- data/README.md +6 -5
- data/docs/DefaultApi.md +7 -6
- data/docs/TranscribeUtterance.md +1 -1
- data/docs/TranscribeUtteranceAllOf.md +28 -0
- data/docs/TranscribeUtteranceAllOfRecord.md +22 -0
- data/lib/freeclimb/api/default_api.rb +11 -7
- data/lib/freeclimb/models/account_request.rb +0 -2
- data/lib/freeclimb/models/account_result.rb +0 -6
- data/lib/freeclimb/models/add_to_conference.rb +0 -16
- data/lib/freeclimb/models/add_to_conference_all_of.rb +0 -16
- data/lib/freeclimb/models/application_result.rb +0 -6
- data/lib/freeclimb/models/buy_incoming_number_request.rb +0 -4
- data/lib/freeclimb/models/call_result.rb +0 -6
- data/lib/freeclimb/models/conference_participant_result.rb +0 -6
- data/lib/freeclimb/models/conference_result.rb +0 -6
- data/lib/freeclimb/models/create_conference.rb +0 -8
- data/lib/freeclimb/models/create_conference_all_of.rb +0 -8
- data/lib/freeclimb/models/create_conference_request.rb +0 -6
- data/lib/freeclimb/models/create_web_rtc_token.rb +0 -4
- data/lib/freeclimb/models/dequeue.rb +1 -0
- data/lib/freeclimb/models/enqueue.rb +0 -6
- data/lib/freeclimb/models/enqueue_all_of.rb +0 -6
- data/lib/freeclimb/models/get_digits.rb +0 -16
- data/lib/freeclimb/models/get_digits_all_of.rb +0 -16
- data/lib/freeclimb/models/get_speech.rb +0 -22
- data/lib/freeclimb/models/get_speech_all_of.rb +0 -22
- data/lib/freeclimb/models/incoming_number_request.rb +0 -2
- data/lib/freeclimb/models/incoming_number_result.rb +0 -10
- data/lib/freeclimb/models/incoming_number_result_all_of.rb +0 -2
- data/lib/freeclimb/models/make_call_request.rb +0 -18
- data/lib/freeclimb/models/message_request.rb +0 -16
- data/lib/freeclimb/models/message_request_all_of.rb +0 -8
- data/lib/freeclimb/models/message_result.rb +0 -8
- data/lib/freeclimb/models/message_result_all_of.rb +0 -2
- data/lib/freeclimb/models/mutable_resource_model.rb +0 -6
- data/lib/freeclimb/models/out_dial.rb +0 -18
- data/lib/freeclimb/models/out_dial_all_of.rb +0 -18
- data/lib/freeclimb/models/park.rb +0 -4
- data/lib/freeclimb/models/park_all_of.rb +0 -4
- data/lib/freeclimb/models/play.rb +0 -4
- data/lib/freeclimb/models/play_all_of.rb +0 -4
- data/lib/freeclimb/models/queue_request.rb +0 -2
- data/lib/freeclimb/models/queue_result.rb +0 -6
- data/lib/freeclimb/models/record_utterance.rb +0 -12
- data/lib/freeclimb/models/record_utterance_all_of.rb +0 -12
- data/lib/freeclimb/models/recording_result.rb +0 -6
- data/lib/freeclimb/models/remove_from_conference.rb +1 -0
- data/lib/freeclimb/models/say.rb +0 -6
- data/lib/freeclimb/models/say_all_of.rb +0 -6
- data/lib/freeclimb/models/send_digits.rb +0 -4
- data/lib/freeclimb/models/send_digits_all_of.rb +0 -4
- data/lib/freeclimb/models/sms.rb +0 -6
- data/lib/freeclimb/models/sms_all_of.rb +0 -6
- data/lib/freeclimb/models/sms_ten_dlc_brand.rb +0 -60
- data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +0 -50
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +0 -44
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +0 -20
- data/lib/freeclimb/models/sms_toll_free_campaign.rb +0 -12
- data/lib/freeclimb/models/start_record_call.rb +1 -0
- data/lib/freeclimb/models/terminate_conference.rb +1 -0
- data/lib/freeclimb/models/transcribe_utterance.rb +11 -16
- data/lib/freeclimb/models/{terminate_conference_all_of.rb → transcribe_utterance_all_of.rb} +67 -14
- data/lib/freeclimb/models/{transcribe_utterance_record.rb → transcribe_utterance_all_of_record.rb} +3 -7
- data/lib/freeclimb/models/unpark.rb +1 -0
- data/lib/freeclimb/models/update_conference_participant_request.rb +0 -2
- data/lib/freeclimb/models/update_conference_request.rb +0 -2
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +3 -2
- data/openapi.json +142 -318
- data/spec/api/default_api_spec.rb +120 -61
- data/spec/models/account_request_spec.rb +8 -6
- data/spec/models/account_result_spec.rb +28 -9
- data/spec/models/add_to_conference_spec.rb +21 -7
- data/spec/models/application_list_spec.rb +46 -22
- data/spec/models/application_request_spec.rb +13 -6
- data/spec/models/application_result_spec.rb +24 -9
- data/spec/models/available_number_list_spec.rb +46 -22
- data/spec/models/available_number_spec.rb +23 -10
- data/spec/models/buy_incoming_number_request_spec.rb +11 -7
- data/spec/models/call_list_spec.rb +46 -22
- data/spec/models/call_result_spec.rb +49 -15
- data/spec/models/capabilities_spec.rb +26 -11
- data/spec/models/conference_list_spec.rb +46 -22
- data/spec/models/conference_participant_list_spec.rb +46 -22
- data/spec/models/conference_participant_result_spec.rb +24 -9
- data/spec/models/conference_result_spec.rb +32 -9
- data/spec/models/create_conference_request_spec.rb +15 -6
- data/spec/models/create_conference_spec.rb +19 -7
- data/spec/models/create_web_rtc_token_spec.rb +18 -12
- data/spec/models/enqueue_spec.rb +16 -9
- data/spec/models/filter_logs_request_spec.rb +9 -7
- data/spec/models/get_digits_spec.rb +43 -19
- data/spec/models/get_speech_spec.rb +60 -24
- data/spec/models/hangup_spec.rb +7 -6
- data/spec/models/incoming_number_list_spec.rb +46 -22
- data/spec/models/incoming_number_request_spec.rb +9 -6
- data/spec/models/incoming_number_result_spec.rb +47 -17
- data/spec/models/log_list_spec.rb +46 -22
- data/spec/models/log_result_spec.rb +21 -9
- data/spec/models/make_call_request_spec.rb +26 -11
- data/spec/models/message_request_spec.rb +26 -12
- data/spec/models/message_result_spec.rb +34 -11
- data/spec/models/messages_list_spec.rb +46 -22
- data/spec/models/mutable_resource_model_spec.rb +15 -9
- data/spec/models/out_dial_spec.rb +33 -13
- data/spec/models/pagination_model_spec.rb +40 -21
- data/spec/models/park_spec.rb +13 -8
- data/spec/models/pause_spec.rb +14 -10
- data/spec/models/percl_command_spec.rb +6 -6
- data/spec/models/percl_script_spec.rb +11 -6
- data/spec/models/play_early_media_spec.rb +9 -7
- data/spec/models/play_spec.rb +17 -10
- data/spec/models/queue_list_spec.rb +46 -22
- data/spec/models/queue_member_list_spec.rb +46 -22
- data/spec/models/queue_member_spec.rb +21 -12
- data/spec/models/queue_request_spec.rb +13 -9
- data/spec/models/queue_result_spec.rb +37 -18
- data/spec/models/record_utterance_spec.rb +28 -13
- data/spec/models/recording_list_spec.rb +46 -22
- data/spec/models/recording_result_spec.rb +25 -12
- data/spec/models/redirect_spec.rb +9 -7
- data/spec/models/reject_spec.rb +7 -6
- data/spec/models/remove_from_conference_spec.rb +0 -67
- data/spec/models/say_spec.rb +18 -10
- data/spec/models/send_digits_spec.rb +17 -10
- data/spec/models/set_listen_spec.rb +8 -6
- data/spec/models/set_talk_spec.rb +8 -6
- data/spec/models/sms_spec.rb +16 -9
- data/spec/models/sms_ten_dlc_brand_spec.rb +38 -4
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +46 -22
- data/spec/models/sms_ten_dlc_campaign_spec.rb +63 -4
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +46 -22
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +25 -7
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +56 -8
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +46 -22
- data/spec/models/sms_toll_free_campaign_spec.rb +29 -15
- data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +46 -22
- data/spec/models/terminate_conference_spec.rb +0 -67
- data/spec/models/tfn_spec.rb +9 -7
- data/spec/models/{transcribe_utterance_record_spec.rb → transcribe_utterance_all_of_record_spec.rb} +78 -67
- data/spec/models/transcribe_utterance_spec.rb +37 -96
- data/spec/models/update_call_request_spec.rb +12 -7
- data/spec/models/update_conference_participant_request_spec.rb +10 -6
- data/spec/models/update_conference_request_spec.rb +15 -6
- metadata +88 -87
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +0 -228
data/openapi.json
CHANGED
@@ -83,16 +83,8 @@
|
|
83
83
|
"schemas": {
|
84
84
|
"AccountStatus": {
|
85
85
|
"type": "string",
|
86
|
-
"enum": [
|
87
|
-
|
88
|
-
"suspended",
|
89
|
-
"active"
|
90
|
-
],
|
91
|
-
"x-enum-varnames": [
|
92
|
-
"CLOSED",
|
93
|
-
"SUSPENDED",
|
94
|
-
"ACTIVE"
|
95
|
-
],
|
86
|
+
"enum": ["closed", "suspended", "active"],
|
87
|
+
"x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
|
96
88
|
"x-enum": true,
|
97
89
|
"description": "The status of this account. It is one of: active, suspended, or closed.",
|
98
90
|
"nullable": true
|
@@ -100,44 +92,24 @@
|
|
100
92
|
"AccountType": {
|
101
93
|
"type": "string",
|
102
94
|
"description": "The type of this account. It is one of: trial or full.",
|
103
|
-
"enum": [
|
104
|
-
"trial",
|
105
|
-
"full"
|
106
|
-
],
|
95
|
+
"enum": ["trial", "full"],
|
107
96
|
"x-enum": true,
|
108
|
-
"x-enum-varnames": [
|
109
|
-
"TRIAL",
|
110
|
-
"FULL"
|
111
|
-
],
|
97
|
+
"x-enum-varnames": ["TRIAL", "FULL"],
|
112
98
|
"nullable": true
|
113
99
|
},
|
114
100
|
"AnsweredBy": {
|
115
101
|
"type": "string",
|
116
102
|
"nullable": true,
|
117
|
-
"enum": [
|
118
|
-
|
119
|
-
"machine"
|
120
|
-
],
|
121
|
-
"x-enum-varnames": [
|
122
|
-
"HUMAN",
|
123
|
-
"MACHINE"
|
124
|
-
],
|
103
|
+
"enum": ["human", "machine"],
|
104
|
+
"x-enum-varnames": ["HUMAN", "MACHINE"],
|
125
105
|
"x-enum": true,
|
126
106
|
"description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
|
127
107
|
},
|
128
108
|
"CallDirection": {
|
129
109
|
"type": "string",
|
130
110
|
"nullable": true,
|
131
|
-
"enum": [
|
132
|
-
|
133
|
-
"outboundAPI",
|
134
|
-
"outboundDial"
|
135
|
-
],
|
136
|
-
"x-enum-varnames": [
|
137
|
-
"INBOUND",
|
138
|
-
"OUTBOUND_API",
|
139
|
-
"OUTBOUND_DIAL"
|
140
|
-
],
|
111
|
+
"enum": ["inbound", "outboundAPI", "outboundDial"],
|
112
|
+
"x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
|
141
113
|
"x-enum": true,
|
142
114
|
"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."
|
143
115
|
},
|
@@ -170,18 +142,8 @@
|
|
170
142
|
"ConferenceStatus": {
|
171
143
|
"type": "string",
|
172
144
|
"nullable": true,
|
173
|
-
"enum": [
|
174
|
-
|
175
|
-
"populated",
|
176
|
-
"inProgress",
|
177
|
-
"terminated"
|
178
|
-
],
|
179
|
-
"x-enum-varnames": [
|
180
|
-
"EMPTY",
|
181
|
-
"POPULATED",
|
182
|
-
"IN_PROGRESS",
|
183
|
-
"TERMINATED"
|
184
|
-
],
|
145
|
+
"enum": ["empty", "populated", "inProgress", "terminated"],
|
146
|
+
"x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
|
185
147
|
"x-enum": true,
|
186
148
|
"description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
|
187
149
|
},
|
@@ -245,28 +207,16 @@
|
|
245
207
|
},
|
246
208
|
"GrammarType": {
|
247
209
|
"type": "string",
|
248
|
-
"enum": [
|
249
|
-
"URL",
|
250
|
-
"BUILTIN"
|
251
|
-
],
|
210
|
+
"enum": ["URL", "BUILTIN"],
|
252
211
|
"nullable": true,
|
253
|
-
"x-enum-varnames": [
|
254
|
-
"URL",
|
255
|
-
"BUILT_IN"
|
256
|
-
],
|
212
|
+
"x-enum-varnames": ["URL", "BUILT_IN"],
|
257
213
|
"x-enum": true,
|
258
214
|
"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."
|
259
215
|
},
|
260
216
|
"IfMachine": {
|
261
217
|
"type": "string",
|
262
|
-
"enum": [
|
263
|
-
|
264
|
-
"hangup"
|
265
|
-
],
|
266
|
-
"x-enum-varnames": [
|
267
|
-
"REDIRECT",
|
268
|
-
"HANGUP"
|
269
|
-
],
|
218
|
+
"enum": ["redirect", "hangup"],
|
219
|
+
"x-enum-varnames": ["REDIRECT", "HANGUP"],
|
270
220
|
"x-enum": true,
|
271
221
|
"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."
|
272
222
|
},
|
@@ -332,42 +282,22 @@
|
|
332
282
|
},
|
333
283
|
"LogLevel": {
|
334
284
|
"type": "string",
|
335
|
-
"enum": [
|
336
|
-
"info",
|
337
|
-
"warning",
|
338
|
-
"error"
|
339
|
-
],
|
285
|
+
"enum": ["info", "warning", "error"],
|
340
286
|
"nullable": true,
|
341
|
-
"x-enum-varnames": [
|
342
|
-
"INFO",
|
343
|
-
"WARNING",
|
344
|
-
"ERROR"
|
345
|
-
],
|
287
|
+
"x-enum-varnames": ["INFO", "WARNING", "ERROR"],
|
346
288
|
"x-enum": true,
|
347
289
|
"description": "Level of the log. Possible values are info, warning, and error."
|
348
290
|
},
|
349
291
|
"MachineType": {
|
350
292
|
"type": "string",
|
351
|
-
"enum": [
|
352
|
-
|
353
|
-
"faxMachine"
|
354
|
-
],
|
355
|
-
"x-enum-varnames": [
|
356
|
-
"ANSWERING_MACHINE",
|
357
|
-
"FAX_MACHINE"
|
358
|
-
],
|
293
|
+
"enum": ["answeringMachine", "faxMachine"],
|
294
|
+
"x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"],
|
359
295
|
"x-enum": true
|
360
296
|
},
|
361
297
|
"MessageDirection": {
|
362
298
|
"type": "string",
|
363
|
-
"enum": [
|
364
|
-
|
365
|
-
"outbound"
|
366
|
-
],
|
367
|
-
"x-enum-varnames": [
|
368
|
-
"INBOUND",
|
369
|
-
"OUTBOUND"
|
370
|
-
],
|
299
|
+
"enum": ["inbound", "outbound"],
|
300
|
+
"x-enum-varnames": ["INBOUND", "OUTBOUND"],
|
371
301
|
"x-enum": true
|
372
302
|
},
|
373
303
|
"MessageStatus": {
|
@@ -405,18 +335,8 @@
|
|
405
335
|
"PlayBeep": {
|
406
336
|
"type": "string",
|
407
337
|
"nullable": true,
|
408
|
-
"enum": [
|
409
|
-
|
410
|
-
"never",
|
411
|
-
"entryOnly",
|
412
|
-
"exitOnly"
|
413
|
-
],
|
414
|
-
"x-enum-varnames": [
|
415
|
-
"ALWAYS",
|
416
|
-
"NEVER",
|
417
|
-
"ENTRY_ONLY",
|
418
|
-
"EXIT_ONLY"
|
419
|
-
],
|
338
|
+
"enum": ["always", "never", "entryOnly", "exitOnly"],
|
339
|
+
"x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
|
420
340
|
"x-enum": true,
|
421
341
|
"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` ",
|
422
342
|
"default": "always",
|
@@ -424,34 +344,14 @@
|
|
424
344
|
},
|
425
345
|
"QueueResultStatus": {
|
426
346
|
"type": "string",
|
427
|
-
"enum": [
|
428
|
-
|
429
|
-
"dequeued",
|
430
|
-
"hangup",
|
431
|
-
"systemError"
|
432
|
-
],
|
433
|
-
"x-enum-varnames": [
|
434
|
-
"QUEUE_FULL",
|
435
|
-
"DEQUEUED",
|
436
|
-
"HANGUP",
|
437
|
-
"SYSTEM_ERROR"
|
438
|
-
],
|
347
|
+
"enum": ["queueFull", "dequeued", "hangup", "systemError"],
|
348
|
+
"x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"],
|
439
349
|
"x-enum": true
|
440
350
|
},
|
441
351
|
"RecordUtteranceTermReason": {
|
442
352
|
"type": "string",
|
443
|
-
"enum": [
|
444
|
-
|
445
|
-
"timeout",
|
446
|
-
"hangup",
|
447
|
-
"maxLength"
|
448
|
-
],
|
449
|
-
"x-enum-varnames": [
|
450
|
-
"FINISH_KEY",
|
451
|
-
"TIMEOUT",
|
452
|
-
"HANGUP",
|
453
|
-
"MAX_LENGTH"
|
454
|
-
],
|
353
|
+
"enum": ["finishKey", "timeout", "hangup", "maxLength"],
|
354
|
+
"x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"],
|
455
355
|
"x-enum": true
|
456
356
|
},
|
457
357
|
"RequestType": {
|
@@ -510,27 +410,15 @@
|
|
510
410
|
},
|
511
411
|
"UpdateCallRequestStatus": {
|
512
412
|
"type": "string",
|
513
|
-
"enum": [
|
514
|
-
|
515
|
-
"completed"
|
516
|
-
],
|
517
|
-
"x-enum-varnames": [
|
518
|
-
"CANCELED",
|
519
|
-
"COMPLETED"
|
520
|
-
],
|
413
|
+
"enum": ["canceled", "completed"],
|
414
|
+
"x-enum-varnames": ["CANCELED", "COMPLETED"],
|
521
415
|
"x-enum": true,
|
522
416
|
"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."
|
523
417
|
},
|
524
418
|
"UpdateConferenceRequestStatus": {
|
525
419
|
"type": "string",
|
526
|
-
"enum": [
|
527
|
-
|
528
|
-
"terminated"
|
529
|
-
],
|
530
|
-
"x-enum-varnames": [
|
531
|
-
"EMPTY",
|
532
|
-
"TERMINATED"
|
533
|
-
],
|
420
|
+
"enum": ["empty", "terminated"],
|
421
|
+
"x-enum-varnames": ["EMPTY", "TERMINATED"],
|
534
422
|
"x-enum": true,
|
535
423
|
"description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
|
536
424
|
},
|
@@ -585,6 +473,7 @@
|
|
585
473
|
},
|
586
474
|
"properties": {
|
587
475
|
"command": {
|
476
|
+
"x-is-no-property": true,
|
588
477
|
"type": "string",
|
589
478
|
"description": "Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments)"
|
590
479
|
}
|
@@ -599,9 +488,7 @@
|
|
599
488
|
},
|
600
489
|
{
|
601
490
|
"type": "object",
|
602
|
-
"required": [
|
603
|
-
"conferenceId"
|
604
|
-
],
|
491
|
+
"required": ["conferenceId"],
|
605
492
|
"properties": {
|
606
493
|
"allowCallControl": {
|
607
494
|
"description": "If `true`, Call control will be enabled for this Participant's Call leg.",
|
@@ -648,14 +535,11 @@
|
|
648
535
|
"x-percl-command": true,
|
649
536
|
"allOf": [
|
650
537
|
{
|
651
|
-
"$ref": "#/components/schemas/PerclCommand"
|
652
|
-
"x-is-uri": true
|
538
|
+
"$ref": "#/components/schemas/PerclCommand"
|
653
539
|
},
|
654
540
|
{
|
655
541
|
"type": "object",
|
656
|
-
"required": [
|
657
|
-
"actionUrl"
|
658
|
-
],
|
542
|
+
"required": ["actionUrl"],
|
659
543
|
"properties": {
|
660
544
|
"actionUrl": {
|
661
545
|
"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. ",
|
@@ -708,11 +592,7 @@
|
|
708
592
|
},
|
709
593
|
{
|
710
594
|
"type": "object",
|
711
|
-
"required": [
|
712
|
-
"queueId",
|
713
|
-
"waitUrl",
|
714
|
-
"actionUrl"
|
715
|
-
],
|
595
|
+
"required": ["queueId", "waitUrl", "actionUrl"],
|
716
596
|
"properties": {
|
717
597
|
"actionUrl": {
|
718
598
|
"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.",
|
@@ -746,9 +626,7 @@
|
|
746
626
|
},
|
747
627
|
{
|
748
628
|
"type": "object",
|
749
|
-
"required": [
|
750
|
-
"actionUrl"
|
751
|
-
],
|
629
|
+
"required": ["actionUrl"],
|
752
630
|
"properties": {
|
753
631
|
"actionUrl": {
|
754
632
|
"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.",
|
@@ -804,16 +682,14 @@
|
|
804
682
|
},
|
805
683
|
{
|
806
684
|
"type": "object",
|
807
|
-
"required": [
|
808
|
-
"actionUrl",
|
809
|
-
"grammarFile"
|
810
|
-
],
|
685
|
+
"required": ["actionUrl", "grammarFile"],
|
811
686
|
"properties": {
|
812
687
|
"actionUrl": {
|
813
688
|
"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.",
|
814
689
|
"type": "string",
|
815
690
|
"format": "uri",
|
816
|
-
"x-is-uri": true
|
691
|
+
"x-is-uri": true,
|
692
|
+
"x-is-url": true
|
817
693
|
},
|
818
694
|
"grammarType": {
|
819
695
|
"$ref": "#/components/schemas/GrammarType"
|
@@ -960,10 +836,7 @@
|
|
960
836
|
},
|
961
837
|
{
|
962
838
|
"type": "object",
|
963
|
-
"required": [
|
964
|
-
"waitUrl",
|
965
|
-
"actionUrl"
|
966
|
-
],
|
839
|
+
"required": ["waitUrl", "actionUrl"],
|
967
840
|
"properties": {
|
968
841
|
"waitUrl": {
|
969
842
|
"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.",
|
@@ -992,9 +865,7 @@
|
|
992
865
|
},
|
993
866
|
{
|
994
867
|
"type": "object",
|
995
|
-
"required": [
|
996
|
-
"length"
|
997
|
-
],
|
868
|
+
"required": ["length"],
|
998
869
|
"properties": {
|
999
870
|
"length": {
|
1000
871
|
"description": "Length in milliseconds. FreeClimb will wait silently before continuing on.",
|
@@ -1012,9 +883,7 @@
|
|
1012
883
|
"$ref": "#/components/schemas/PerclCommand"
|
1013
884
|
},
|
1014
885
|
{
|
1015
|
-
"required": [
|
1016
|
-
"file"
|
1017
|
-
],
|
886
|
+
"required": ["file"],
|
1018
887
|
"type": "object",
|
1019
888
|
"properties": {
|
1020
889
|
"file": {
|
@@ -1041,9 +910,7 @@
|
|
1041
910
|
"$ref": "#/components/schemas/PerclCommand"
|
1042
911
|
},
|
1043
912
|
{
|
1044
|
-
"required": [
|
1045
|
-
"file"
|
1046
|
-
],
|
913
|
+
"required": ["file"],
|
1047
914
|
"type": "object",
|
1048
915
|
"properties": {
|
1049
916
|
"file": {
|
@@ -1063,9 +930,7 @@
|
|
1063
930
|
"x-is-uri": true
|
1064
931
|
},
|
1065
932
|
{
|
1066
|
-
"required": [
|
1067
|
-
"actionUrl"
|
1068
|
-
],
|
933
|
+
"required": ["actionUrl"],
|
1069
934
|
"type": "object",
|
1070
935
|
"properties": {
|
1071
936
|
"actionUrl": {
|
@@ -1110,9 +975,7 @@
|
|
1110
975
|
"x-is-uri": true
|
1111
976
|
},
|
1112
977
|
{
|
1113
|
-
"required": [
|
1114
|
-
"actionUrl"
|
1115
|
-
],
|
978
|
+
"required": ["actionUrl"],
|
1116
979
|
"type": "object",
|
1117
980
|
"properties": {
|
1118
981
|
"actionUrl": {
|
@@ -1145,6 +1008,7 @@
|
|
1145
1008
|
"RemoveFromConference": {
|
1146
1009
|
"description": "The `RemoveFromConference` command removes a Participant from a Conference but does not hang up. Instead, the Call is simply unbridged and what happens next with the Call is determined by the PerCL returned in response to the `leaveConferenceUrl` attribute.",
|
1147
1010
|
"x-percl-command": true,
|
1011
|
+
"x-no-properties": true,
|
1148
1012
|
"allOf": [
|
1149
1013
|
{
|
1150
1014
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1164,9 +1028,7 @@
|
|
1164
1028
|
"$ref": "#/components/schemas/PerclCommand"
|
1165
1029
|
},
|
1166
1030
|
{
|
1167
|
-
"required": [
|
1168
|
-
"text"
|
1169
|
-
],
|
1031
|
+
"required": ["text"],
|
1170
1032
|
"type": "object",
|
1171
1033
|
"properties": {
|
1172
1034
|
"text": {
|
@@ -1198,9 +1060,7 @@
|
|
1198
1060
|
"$ref": "#/components/schemas/PerclCommand"
|
1199
1061
|
},
|
1200
1062
|
{
|
1201
|
-
"required": [
|
1202
|
-
"digits"
|
1203
|
-
],
|
1063
|
+
"required": ["digits"],
|
1204
1064
|
"type": "object",
|
1205
1065
|
"properties": {
|
1206
1066
|
"digits": {
|
@@ -1265,11 +1125,7 @@
|
|
1265
1125
|
"$ref": "#/components/schemas/PerclCommand"
|
1266
1126
|
},
|
1267
1127
|
{
|
1268
|
-
"required": [
|
1269
|
-
"to",
|
1270
|
-
"from",
|
1271
|
-
"text"
|
1272
|
-
],
|
1128
|
+
"required": ["to", "from", "text"],
|
1273
1129
|
"type": "object",
|
1274
1130
|
"properties": {
|
1275
1131
|
"to": {
|
@@ -1277,6 +1133,7 @@
|
|
1277
1133
|
"type": "string"
|
1278
1134
|
},
|
1279
1135
|
"from": {
|
1136
|
+
"x-is-private-property": true,
|
1280
1137
|
"description": "E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb.",
|
1281
1138
|
"type": "string"
|
1282
1139
|
},
|
@@ -1308,6 +1165,7 @@
|
|
1308
1165
|
"TerminateConference": {
|
1309
1166
|
"description": "The `TerminateConference` command terminates an existing Conference. Any active participants are hung up on by FreeClimb. If this is not the desired behavior, use the `RemoveFromConference` command to unbridge Calls that should not be hung up. Note: The Call requesting TerminateConference must be on the same Conference for this command to execute.",
|
1310
1167
|
"x-percl-command": true,
|
1168
|
+
"x-no-properties": true,
|
1311
1169
|
"allOf": [
|
1312
1170
|
{
|
1313
1171
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1396,13 +1254,7 @@
|
|
1396
1254
|
"Capabilities": {
|
1397
1255
|
"description": "Details for which features this number may be used.",
|
1398
1256
|
"type": "object",
|
1399
|
-
"required": [
|
1400
|
-
"voice",
|
1401
|
-
"sms",
|
1402
|
-
"tollFree",
|
1403
|
-
"tenDLC",
|
1404
|
-
"shortCode"
|
1405
|
-
],
|
1257
|
+
"required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
|
1406
1258
|
"x-is-object": true,
|
1407
1259
|
"properties": {
|
1408
1260
|
"voice": {
|
@@ -1435,9 +1287,7 @@
|
|
1435
1287
|
"TFN": {
|
1436
1288
|
"description": "TollFree Campaign details for this number",
|
1437
1289
|
"type": "object",
|
1438
|
-
"required": [
|
1439
|
-
"campaignId"
|
1440
|
-
],
|
1290
|
+
"required": ["campaignId"],
|
1441
1291
|
"x-is-object": true,
|
1442
1292
|
"properties": {
|
1443
1293
|
"campaignId": {
|
@@ -1794,9 +1644,7 @@
|
|
1794
1644
|
},
|
1795
1645
|
"BuyIncomingNumberRequest": {
|
1796
1646
|
"type": "object",
|
1797
|
-
"required": [
|
1798
|
-
"phoneNumber"
|
1799
|
-
],
|
1647
|
+
"required": ["phoneNumber"],
|
1800
1648
|
"properties": {
|
1801
1649
|
"phoneNumber": {
|
1802
1650
|
"type": "string",
|
@@ -1836,6 +1684,7 @@
|
|
1836
1684
|
"nullable": true
|
1837
1685
|
},
|
1838
1686
|
"from": {
|
1687
|
+
"x-is-private-property": true,
|
1839
1688
|
"type": "string",
|
1840
1689
|
"description": "Phone number that initiated this Call.",
|
1841
1690
|
"nullable": true
|
@@ -1895,9 +1744,7 @@
|
|
1895
1744
|
},
|
1896
1745
|
"UpdateCallRequest": {
|
1897
1746
|
"type": "object",
|
1898
|
-
"required": [
|
1899
|
-
"status"
|
1900
|
-
],
|
1747
|
+
"required": ["status"],
|
1901
1748
|
"properties": {
|
1902
1749
|
"status": {
|
1903
1750
|
"$ref": "#/components/schemas/UpdateCallRequestStatus"
|
@@ -1906,12 +1753,10 @@
|
|
1906
1753
|
},
|
1907
1754
|
"MakeCallRequest": {
|
1908
1755
|
"type": "object",
|
1909
|
-
"required": [
|
1910
|
-
"from",
|
1911
|
-
"to"
|
1912
|
-
],
|
1756
|
+
"required": ["from", "to"],
|
1913
1757
|
"properties": {
|
1914
1758
|
"from": {
|
1759
|
+
"x-is-private-property": true,
|
1915
1760
|
"type": "string",
|
1916
1761
|
"description": "Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb."
|
1917
1762
|
},
|
@@ -2177,13 +2022,10 @@
|
|
2177
2022
|
},
|
2178
2023
|
{
|
2179
2024
|
"type": "object",
|
2180
|
-
"required": [
|
2181
|
-
"from",
|
2182
|
-
"to",
|
2183
|
-
"text"
|
2184
|
-
],
|
2025
|
+
"required": ["from", "to", "text"],
|
2185
2026
|
"properties": {
|
2186
2027
|
"from": {
|
2028
|
+
"x-is-private-property": true,
|
2187
2029
|
"type": "string",
|
2188
2030
|
"description": "Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb."
|
2189
2031
|
},
|
@@ -2202,6 +2044,7 @@
|
|
2202
2044
|
"mediaUrls": {
|
2203
2045
|
"type": "array",
|
2204
2046
|
"description": "an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.",
|
2047
|
+
"x-is-list": true,
|
2205
2048
|
"items": {
|
2206
2049
|
"type": "string",
|
2207
2050
|
"format": "uri"
|
@@ -2253,6 +2096,7 @@
|
|
2253
2096
|
"$ref": "#/components/schemas/MessageStatus"
|
2254
2097
|
},
|
2255
2098
|
"from": {
|
2099
|
+
"x-is-private-property": true,
|
2256
2100
|
"type": "string",
|
2257
2101
|
"description": "Phone number in E.164 format that sent the message.",
|
2258
2102
|
"nullable": true
|
@@ -2295,6 +2139,7 @@
|
|
2295
2139
|
"mediaUrls": {
|
2296
2140
|
"type": "array",
|
2297
2141
|
"description": "an array of HTTP URLs which were attached this this message",
|
2142
|
+
"x-is-list": true,
|
2298
2143
|
"items": {
|
2299
2144
|
"type": "string",
|
2300
2145
|
"format": "uri"
|
@@ -2552,9 +2397,7 @@
|
|
2552
2397
|
},
|
2553
2398
|
"FilterLogsRequest": {
|
2554
2399
|
"type": "object",
|
2555
|
-
"required": [
|
2556
|
-
"pql"
|
2557
|
-
],
|
2400
|
+
"required": ["pql"],
|
2558
2401
|
"properties": {
|
2559
2402
|
"pql": {
|
2560
2403
|
"type": "string",
|
@@ -2617,14 +2460,9 @@
|
|
2617
2460
|
"type": "string",
|
2618
2461
|
"x-has-writer": true,
|
2619
2462
|
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2620
|
-
"enum":
|
2621
|
-
|
2622
|
-
|
2623
|
-
],
|
2624
|
-
"x-enum-varnames": [
|
2625
|
-
"ACTIVE",
|
2626
|
-
"EXPIRED"
|
2627
|
-
]
|
2463
|
+
"x-enum-type": "SMSTenDLCCampaignStatusEnum",
|
2464
|
+
"enum": ["ACTIVE", "EXPIRED"],
|
2465
|
+
"x-enum-varnames": ["ACTIVE", "EXPIRED"]
|
2628
2466
|
},
|
2629
2467
|
"createDate": {
|
2630
2468
|
"type": "string",
|
@@ -2849,12 +2687,7 @@
|
|
2849
2687
|
]
|
2850
2688
|
},
|
2851
2689
|
"SMSTenDLCPartnerCampaign": {
|
2852
|
-
"required": [
|
2853
|
-
"brandId",
|
2854
|
-
"campaignId",
|
2855
|
-
"description",
|
2856
|
-
"usecase"
|
2857
|
-
],
|
2690
|
+
"required": ["brandId", "campaignId", "description", "usecase"],
|
2858
2691
|
"type": "object",
|
2859
2692
|
"properties": {
|
2860
2693
|
"accountId": {
|
@@ -2870,14 +2703,9 @@
|
|
2870
2703
|
"type": "string",
|
2871
2704
|
"x-has-writer": true,
|
2872
2705
|
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2873
|
-
"enum":
|
2874
|
-
|
2875
|
-
|
2876
|
-
],
|
2877
|
-
"x-enum-varnames": [
|
2878
|
-
"ACTIVE",
|
2879
|
-
"EXPIRED"
|
2880
|
-
]
|
2706
|
+
"x-enum-type": "SMSTenDLCPartnerCampaignStatusEnum",
|
2707
|
+
"enum": ["ACTIVE", "EXPIRED"],
|
2708
|
+
"x-enum-varnames": ["ACTIVE", "EXPIRED"]
|
2881
2709
|
},
|
2882
2710
|
"createDate": {
|
2883
2711
|
"type": "string",
|
@@ -3056,10 +2884,7 @@
|
|
3056
2884
|
}
|
3057
2885
|
},
|
3058
2886
|
"SMSTenDLCPartnerCampaignBrand": {
|
3059
|
-
"required": [
|
3060
|
-
"email",
|
3061
|
-
"phone"
|
3062
|
-
],
|
2887
|
+
"required": ["email", "phone"],
|
3063
2888
|
"type": "object",
|
3064
2889
|
"x-is-object": true,
|
3065
2890
|
"properties": {
|
@@ -3163,6 +2988,7 @@
|
|
3163
2988
|
"vertical"
|
3164
2989
|
],
|
3165
2990
|
"type": "object",
|
2991
|
+
"x-sms-ten-dlc-brand": true,
|
3166
2992
|
"properties": {
|
3167
2993
|
"accountId": {
|
3168
2994
|
"type": "string",
|
@@ -3174,6 +3000,7 @@
|
|
3174
3000
|
"type": "string",
|
3175
3001
|
"x-has-writer": true,
|
3176
3002
|
"description": "Entity type behind the brand. This is the form of business establishment.",
|
3003
|
+
"x-enum-type": "SMSTenDLCBrandEntityTypeEnum",
|
3177
3004
|
"enum": [
|
3178
3005
|
"PRIVATE_PROFIT",
|
3179
3006
|
"PUBLIC_PROFIT",
|
@@ -3287,6 +3114,7 @@
|
|
3287
3114
|
"x-has-writer": true,
|
3288
3115
|
"description": "(Required for public company) stock exchange.",
|
3289
3116
|
"example": "NASDAQ",
|
3117
|
+
"x-enum-type": "SMSTenDLCBrandStockExchangeEnum",
|
3290
3118
|
"enum": [
|
3291
3119
|
"NONE",
|
3292
3120
|
"NASDAQ",
|
@@ -3361,6 +3189,7 @@
|
|
3361
3189
|
"type": "string",
|
3362
3190
|
"x-has-writer": true,
|
3363
3191
|
"description": "Brand relationship to the CSP",
|
3192
|
+
"x-enum-type": "SMSTenDLCBrandBrandRelationshipEnum",
|
3364
3193
|
"enum": [
|
3365
3194
|
"BASIC_ACCOUNT",
|
3366
3195
|
"SMALL_ACCOUNT",
|
@@ -3389,18 +3218,9 @@
|
|
3389
3218
|
"altBusinessIdType": {
|
3390
3219
|
"type": "string",
|
3391
3220
|
"x-has-writer": true,
|
3392
|
-
"enum":
|
3393
|
-
|
3394
|
-
|
3395
|
-
"GIIN",
|
3396
|
-
"LEI"
|
3397
|
-
],
|
3398
|
-
"x-enum-varnames": [
|
3399
|
-
"NONE",
|
3400
|
-
"DUNS",
|
3401
|
-
"GIIN",
|
3402
|
-
"LEI"
|
3403
|
-
],
|
3221
|
+
"x-enum-type": "SMSTenDLCBrandAltBusinessIdTypeEnum",
|
3222
|
+
"enum": ["NONE", "DUNS", "GIIN", "LEI"],
|
3223
|
+
"x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
|
3404
3224
|
"description": "The type of the Alternative business identifier"
|
3405
3225
|
},
|
3406
3226
|
"universalEin": {
|
@@ -3431,6 +3251,7 @@
|
|
3431
3251
|
"type": "string",
|
3432
3252
|
"x-has-writer": true,
|
3433
3253
|
"description": "TCR assessment of the brand identification status.",
|
3254
|
+
"x-enum-type": "SMSTenDLCBrandIdentityStatusEnum",
|
3434
3255
|
"enum": [
|
3435
3256
|
"SELF_DECLARED",
|
3436
3257
|
"UNVERIFIED",
|
@@ -3515,6 +3336,7 @@
|
|
3515
3336
|
"dateUpdated",
|
3516
3337
|
"revision"
|
3517
3338
|
],
|
3339
|
+
"x-sms-toll-free-campaign": true,
|
3518
3340
|
"properties": {
|
3519
3341
|
"accountId": {
|
3520
3342
|
"type": "string",
|
@@ -3532,6 +3354,7 @@
|
|
3532
3354
|
"type": "string",
|
3533
3355
|
"x-has-writer": true,
|
3534
3356
|
"description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
|
3357
|
+
"x-enum-type": "SMSTollFreeCampaignRegistrationStatusEnum",
|
3535
3358
|
"enum": [
|
3536
3359
|
"UNREGISTERED",
|
3537
3360
|
"INITIATED",
|
@@ -3563,58 +3386,66 @@
|
|
3563
3386
|
"x-stoplight": {
|
3564
3387
|
"id": "u509r3zqc38ze"
|
3565
3388
|
},
|
3566
|
-
"x-percl-command": true,
|
3567
|
-
"type": "object",
|
3568
3389
|
"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.",
|
3569
|
-
"
|
3570
|
-
|
3571
|
-
|
3572
|
-
|
3573
|
-
"playBeep": {
|
3574
|
-
"type": "boolean",
|
3575
|
-
"default": false
|
3390
|
+
"x-percl-command": true,
|
3391
|
+
"allOf": [
|
3392
|
+
{
|
3393
|
+
"$ref": "#/components/schemas/PerclCommand"
|
3576
3394
|
},
|
3577
|
-
|
3395
|
+
{
|
3396
|
+
"required": ["actionUrl"],
|
3578
3397
|
"type": "object",
|
3398
|
+
"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.",
|
3579
3399
|
"properties": {
|
3580
|
-
"
|
3400
|
+
"actionUrl": {
|
3401
|
+
"type": "string"
|
3402
|
+
},
|
3403
|
+
"playBeep": {
|
3581
3404
|
"type": "boolean",
|
3582
3405
|
"default": false
|
3583
3406
|
},
|
3584
|
-
"
|
3585
|
-
"type": "
|
3586
|
-
"
|
3587
|
-
"
|
3588
|
-
|
3407
|
+
"record": {
|
3408
|
+
"type": "object",
|
3409
|
+
"x-is-object": true,
|
3410
|
+
"properties": {
|
3411
|
+
"saveRecording": {
|
3412
|
+
"type": "boolean",
|
3413
|
+
"default": false
|
3414
|
+
},
|
3415
|
+
"maxLengthSec": {
|
3416
|
+
"type": "integer",
|
3417
|
+
"minimum": 1,
|
3418
|
+
"maximum": 60,
|
3419
|
+
"default": 60
|
3420
|
+
},
|
3421
|
+
"rcrdTerminationSilenceTimeMs": {
|
3422
|
+
"type": "integer",
|
3423
|
+
"exclusiveMinimum": true,
|
3424
|
+
"minimum": 0,
|
3425
|
+
"maximum": 3000
|
3426
|
+
}
|
3427
|
+
}
|
3589
3428
|
},
|
3590
|
-
"
|
3591
|
-
"type": "
|
3592
|
-
"
|
3593
|
-
|
3594
|
-
|
3429
|
+
"privacyForLogging": {
|
3430
|
+
"type": "boolean",
|
3431
|
+
"default": false
|
3432
|
+
},
|
3433
|
+
"privacyForRecording": {
|
3434
|
+
"type": "boolean",
|
3435
|
+
"default": false
|
3436
|
+
},
|
3437
|
+
"prompts": {
|
3438
|
+
"type": "array",
|
3439
|
+
"x-is-list": true,
|
3440
|
+
"items": {}
|
3595
3441
|
}
|
3596
3442
|
}
|
3597
|
-
},
|
3598
|
-
"privacyForLogging": {
|
3599
|
-
"type": "boolean",
|
3600
|
-
"default": false
|
3601
|
-
},
|
3602
|
-
"privacyForRecording": {
|
3603
|
-
"type": "boolean",
|
3604
|
-
"default": false
|
3605
|
-
},
|
3606
|
-
"prompts": {
|
3607
|
-
"type": "array",
|
3608
|
-
"items": {}
|
3609
3443
|
}
|
3610
|
-
},
|
3611
|
-
"required": [
|
3612
|
-
"actionUrl"
|
3613
3444
|
],
|
3614
3445
|
"x-examples": {
|
3615
3446
|
"Example 1": {
|
3616
3447
|
"TranscribeUtterance": {
|
3617
|
-
"actionUrl": "http://
|
3448
|
+
"actionUrl": "http://yoursite.com/handleTranscription",
|
3618
3449
|
"record": {
|
3619
3450
|
"maxLengthSec": 60,
|
3620
3451
|
"saveRecording": true,
|
@@ -3634,11 +3465,8 @@
|
|
3634
3465
|
},
|
3635
3466
|
"CreateWebRTCToken": {
|
3636
3467
|
"type": "object",
|
3637
|
-
"required": [
|
3638
|
-
|
3639
|
-
"from",
|
3640
|
-
"uses"
|
3641
|
-
],
|
3468
|
+
"required": ["to", "from", "uses"],
|
3469
|
+
"x-web-rtc": true,
|
3642
3470
|
"additionalProperties": false,
|
3643
3471
|
"properties": {
|
3644
3472
|
"to": {
|
@@ -3646,6 +3474,7 @@
|
|
3646
3474
|
"description": "E.164 formatted phone number to which calls using this token will be made."
|
3647
3475
|
},
|
3648
3476
|
"from": {
|
3477
|
+
"x-is-private-property": true,
|
3649
3478
|
"type": "string",
|
3650
3479
|
"description": "E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made."
|
3651
3480
|
},
|
@@ -4534,6 +4363,7 @@
|
|
4534
4363
|
"summary": "Make a JWT for WebRTC calling",
|
4535
4364
|
"description": "Make a JWT for WebRTC calling",
|
4536
4365
|
"operationId": "make-a-webrtc-jwt",
|
4366
|
+
"x-web-rtc": true,
|
4537
4367
|
"parameters": [
|
4538
4368
|
{
|
4539
4369
|
"$ref": "#/components/parameters/AccountId"
|
@@ -4923,15 +4753,6 @@
|
|
4923
4753
|
"type": "string"
|
4924
4754
|
}
|
4925
4755
|
},
|
4926
|
-
{
|
4927
|
-
"name": "conferenceId",
|
4928
|
-
"in": "query",
|
4929
|
-
"description": "Show only Recordings made during the conference with this ID.",
|
4930
|
-
"required": false,
|
4931
|
-
"schema": {
|
4932
|
-
"type": "string"
|
4933
|
-
}
|
4934
|
-
},
|
4935
4756
|
{
|
4936
4757
|
"name": "dateCreated",
|
4937
4758
|
"in": "query",
|
@@ -4943,6 +4764,15 @@
|
|
4943
4764
|
},
|
4944
4765
|
{
|
4945
4766
|
"$ref": "#/components/parameters/AccountId"
|
4767
|
+
},
|
4768
|
+
{
|
4769
|
+
"name": "conferenceId",
|
4770
|
+
"in": "path",
|
4771
|
+
"description": "Show only Recordings made during the conference with this ID.",
|
4772
|
+
"required": true,
|
4773
|
+
"schema": {
|
4774
|
+
"type": "string"
|
4775
|
+
}
|
4946
4776
|
}
|
4947
4777
|
],
|
4948
4778
|
"responses": {
|
@@ -6110,11 +5940,5 @@
|
|
6110
5940
|
"x-explorer-enabled": true,
|
6111
5941
|
"x-proxy-enabled": true,
|
6112
5942
|
"x-samples-enabled": false,
|
6113
|
-
"x-samples-languages": [
|
6114
|
-
|
6115
|
-
"node",
|
6116
|
-
"ruby",
|
6117
|
-
"javascript",
|
6118
|
-
"python"
|
6119
|
-
]
|
6120
|
-
}
|
5943
|
+
"x-samples-languages": ["curl", "node", "ruby", "javascript", "python"]
|
5944
|
+
}
|