-
Notifications
You must be signed in to change notification settings - Fork 79
/
twilio_flex_v1.yaml
9403 lines (9403 loc) · 354 KB
/
twilio_flex_v1.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
securitySchemes:
accountSid_authToken:
scheme: basic
type: http
schemas:
ai_insights_enum_tag_group:
type: string
enum:
- topics
flex.v1.channel:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Channel resource and owns this Workflow.
flex_flow_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FO[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex Flow.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^CH[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Channel resource.
user_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^US[0-9a-fA-F]{32}$
nullable: true
description: The SID of the chat user.
task_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WT[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskRouter Task. Only valid when integration
type is `task`. `null` for integration types `studio` & `external`
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Flex chat channel resource.
date_created:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the Flex chat channel was created
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the Flex chat channel was last
updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
flex.v1.configuration:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Configuration resource.
date_created:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the Configuration resource was
created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
date_updated:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the Configuration resource was
last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format.
attributes:
nullable: true
description: An object that contains application-specific data.
status:
type: string
$ref: '#/components/schemas/configuration_enum_status'
nullable: true
description: 'The status of the Flex onboarding. Can be: `ok`, `inprogress`,`notstarted`.'
taskrouter_workspace_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskRouter Workspace.
taskrouter_target_workflow_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WW[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskRouter target Workflow.
taskrouter_target_taskqueue_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WQ[0-9a-fA-F]{32}$
nullable: true
description: The SID of the TaskRouter Target TaskQueue.
taskrouter_taskqueues:
type: array
items: {}
nullable: true
description: The list of TaskRouter TaskQueues.
taskrouter_skills:
type: array
items: {}
nullable: true
description: The Skill description for TaskRouter workers.
taskrouter_worker_channels:
nullable: true
description: The TaskRouter default channel capacities and availability
for workers.
taskrouter_worker_attributes:
nullable: true
description: The TaskRouter Worker attributes.
taskrouter_offline_activity_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^WA[0-9a-fA-F]{32}$
nullable: true
description: The TaskRouter SID of the offline activity.
runtime_domain:
type: string
nullable: true
description: The URL where the Flex instance is hosted.
messaging_service_instance_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^MG[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Messaging service instance.
chat_service_instance_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the chat service this user belongs to.
flex_service_instance_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex service instance.
flex_instance_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^GO[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex instance.
ui_language:
type: string
nullable: true
description: The primary language of the Flex UI.
ui_attributes:
nullable: true
description: The object that describes Flex UI characteristics and settings.
ui_dependencies:
nullable: true
description: The object that defines the NPM packages and versions to be
used in Hosted Flex.
ui_version:
type: string
nullable: true
description: The Pinned UI version.
service_version:
type: string
nullable: true
description: The Flex Service version.
call_recording_enabled:
type: boolean
nullable: true
description: Whether call recording is enabled.
call_recording_webhook_url:
type: string
nullable: true
description: The call recording webhook URL.
crm_enabled:
type: boolean
nullable: true
description: Whether CRM is present for Flex.
crm_type:
type: string
nullable: true
description: The CRM type.
crm_callback_url:
type: string
nullable: true
description: The CRM Callback URL.
crm_fallback_url:
type: string
nullable: true
description: The CRM Fallback URL.
crm_attributes:
nullable: true
description: An object that contains the CRM attributes.
public_attributes:
nullable: true
description: The list of public attributes, which are visible to unauthenticated
clients.
plugin_service_enabled:
type: boolean
nullable: true
description: Whether the plugin service enabled.
plugin_service_attributes:
nullable: true
description: The plugin service attributes.
integrations:
type: array
items: {}
nullable: true
description: A list of objects that contain the configurations for the Integrations
supported in this configuration.
outbound_call_flows:
nullable: true
description: The list of outbound call flows.
serverless_service_sids:
type: array
items:
type: string
minLength: 34
maxLength: 34
pattern: ^ZS[0-9a-fA-F]{32}$
nullable: true
description: The list of serverless service SIDs.
queue_stats_configuration:
nullable: true
description: Configurable parameters for Queues Statistics.
notifications:
nullable: true
description: Configurable parameters for Notifications.
markdown:
nullable: true
description: Configurable parameters for Markdown.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Configuration resource.
flex_insights_hr:
nullable: true
description: Object with enabled/disabled flag with list of workspaces.
flex_insights_drilldown:
type: boolean
nullable: true
description: Setting this to true will redirect Flex UI to the URL set in
flex_url
flex_url:
type: string
nullable: true
description: URL to redirect to in case drilldown is enabled.
channel_configs:
type: array
items: {}
nullable: true
description: Settings for different limits for Flex Conversations channels
attachments.
debugger_integration:
nullable: true
description: Configurable parameters for Debugger Integration.
flex_ui_status_report:
nullable: true
description: Configurable parameters for Flex UI Status report.
agent_conv_end_methods:
nullable: true
description: Agent conversation end methods.
citrix_voice_vdi:
nullable: true
description: Citrix voice vdi configuration and settings.
offline_config:
nullable: true
description: Presence and presence ttl configuration
configuration_enum_status:
type: string
enum:
- ok
- inprogress
- notstarted
flex.v1.plugin_configuration.configured_plugin:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that the Flex Plugin resource is installed for.
configuration_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FJ[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex Plugin Configuration that this Flex Plugin
belongs to.
plugin_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FP[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex Plugin.
plugin_version_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FV[0-9a-fA-F]{32}$
nullable: true
description: The SID of the Flex Plugin Version.
phase:
type: integer
default: 0
description: The phase this Flex Plugin would initialize at runtime.
plugin_url:
type: string
nullable: true
description: The URL of where the Flex Plugin Version JavaScript bundle
is hosted on.
x-twilio:
pii:
handling: standard
deleteSla: 30
unique_name:
type: string
nullable: true
description: The name that uniquely identifies this Flex Plugin resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
friendly_name:
type: string
nullable: true
description: The friendly name of this Flex Plugin resource.
description:
type: string
nullable: true
description: A descriptive string that you create to describe the plugin
resource. It can be up to 500 characters long
plugin_archived:
type: boolean
nullable: true
description: Whether the Flex Plugin is archived. The default value is false.
version:
type: string
nullable: true
description: The latest version of this Flex Plugin Version.
changelog:
type: string
nullable: true
description: A changelog that describes the changes this Flex Plugin Version
brings.
plugin_version_archived:
type: boolean
nullable: true
description: Whether the Flex Plugin Version is archived. The default value
is false.
private:
type: boolean
nullable: true
description: Whether to validate the request is authorized to access the
Flex Plugin Version.
date_created:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the Flex Plugin was installed
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Flex Plugin resource.
flex.v1.flex_flow:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Flow resource and owns this Workflow.
date_created:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the resource was created specified
in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
date_updated:
type: string
format: date-time
nullable: true
description: The date and time in GMT when the resource was last updated
specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FO[0-9a-fA-F]{32}$
nullable: true
description: The unique string that we created to identify the Flex Flow
resource.
friendly_name:
type: string
nullable: true
description: The string that you assigned to describe the resource.
x-twilio:
pii:
handling: standard
deleteSla: 30
chat_service_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^IS[0-9a-fA-F]{32}$
nullable: true
description: The SID of the chat service.
channel_type:
type: string
$ref: '#/components/schemas/flex_flow_enum_channel_type'
nullable: true
description: "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`,\
\ `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes\
\ it on to the Task attributes for Tasks created based on this Flex Flow.\
\ The Task attributes will be used by the Flex UI to render the respective\
\ Task as appropriate (applying channel-specific design and length limits).\
\ If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex\
\ widget should set the Task Channel to Programmable Chat."
contact_identity:
type: string
nullable: true
description: The channel contact's Identity.
enabled:
type: boolean
nullable: true
description: Whether the Flex Flow is enabled.
integration_type:
type: string
$ref: '#/components/schemas/flex_flow_enum_integration_type'
nullable: true
description: 'The software that will handle inbound messages. [Integration
Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types)
can be: `studio`, `external`, or `task`.'
integration:
nullable: true
description: An object that contains specific parameters for the integration.
long_lived:
type: boolean
nullable: true
description: When enabled, Flex will keep the chat channel active so that
it may be used for subsequent interactions with a contact identity. Defaults
to `false`.
janitor_enabled:
type: boolean
nullable: true
description: When enabled, the Messaging Channel Janitor will remove active
Proxy sessions if the associated Task is deleted outside of the Flex UI.
Defaults to `false`.
url:
type: string
format: uri
nullable: true
description: The absolute URL of the Flex Flow resource.
flex_flow_enum_channel_type:
type: string
enum:
- web
- sms
- facebook
- whatsapp
- line
- custom
flex_flow_enum_integration_type:
type: string
enum:
- studio
- external
- task
flex_meeting_callback_events_enum_webhook_method:
type: string
enum:
- POST
- GET
flex.v1.insights_assessments:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The unique SID identifier of the Account.
assessment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FM[0-9a-fA-F]{32}$
nullable: true
description: The SID of the assessment
offset:
type: number
nullable: true
description: Offset of the conversation
report:
type: boolean
nullable: true
description: 'The flag indicating if this assessment is part of report '
weight:
type: number
nullable: true
description: The weightage given to this comment
agent_id:
type: string
nullable: true
description: The id of the Agent
segment_id:
type: string
nullable: true
description: Segment Id of conversation
user_name:
type: string
nullable: true
description: The name of the user.
user_email:
type: string
nullable: true
description: The email id of the user.
answer_text:
type: string
nullable: true
description: The answer text selected by user
answer_id:
type: string
nullable: true
description: The id of the answer selected by user
assessment:
nullable: true
description: Assessment Details associated with an assessment
timestamp:
type: number
nullable: true
url:
type: string
format: uri
nullable: true
flex.v1.insights_assessments_comment:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
assessment_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FM[0-9a-fA-F]{32}$
nullable: true
description: The SID of the assessment.
comment:
nullable: true
description: The comment added for assessment.
offset:
type: number
nullable: true
description: The offset
report:
type: boolean
nullable: true
description: 'The flag indicating if this assessment is part of report '
weight:
type: number
nullable: true
description: The weightage given to this comment
agent_id:
type: string
nullable: true
description: The id of the agent.
segment_id:
type: string
nullable: true
description: The id of the segment.
user_name:
type: string
nullable: true
description: The name of the user.
user_email:
type: string
nullable: true
description: The email id of the user.
timestamp:
type: number
nullable: true
description: The timestamp when the record is inserted
url:
type: string
format: uri
nullable: true
insights_conversational_ai_enum_granularity:
type: string
enum:
- days
- weeks
- months
- quarters
- years
insights_conversational_ai_enum_name:
type: string
enum:
- predictive_scores
- channel_metrics
- agent_metrics
- queue_metrics
- agents_csat_summary
- topic_metrics
- conversation_metrics
- trend_metrics
insights_conversational_ai_enum_type:
type: string
enum:
- metrics
- summary
- trend
insights_conversational_ai_enum_sort_direction:
type: string
enum:
- asc
- desc
insights_conversational_ai_enum_sort_by:
type: string
enum:
- record_count
- scored_count
- total
- mean
- scored_mean
- score
insights_conversational_ai_enum_score_id:
type: string
enum:
- ~predicted-csat
- ~agent-experience
- ~customer-effort
- ~multitouch-risk
insights_conversational_ai_enum_tier:
type: string
enum:
- Low
- High
- Neutral
flex.v1.insights_conversations:
type: object
properties:
account_id:
type: string
nullable: true
description: The id of the account.
conversation_id:
type: string
nullable: true
description: The unique id of the conversation
segment_count:
type: integer
default: 0
description: The count of segments for a conversation
segments:
type: array
items: {}
nullable: true
description: The Segments of a conversation
flex.v1.insights_questionnaires:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
questionnaire_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^GM[0-9a-fA-F]{32}$
nullable: true
description: The sid of this questionnaire
name:
type: string
nullable: true
description: The name of this category.
description:
type: string
nullable: true
description: The description of this questionnaire
active:
type: boolean
nullable: true
description: The flag to enable or disable questionnaire
questions:
type: array
items: {}
nullable: true
description: The list of questions with category for a questionnaire
url:
type: string
format: uri
nullable: true
flex.v1.insights_questionnaires_category:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
category_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^FY[0-9a-fA-F]{32}$
nullable: true
description: The SID of the category
name:
type: string
nullable: true
description: The name of this category.
url:
type: string
format: uri
nullable: true
flex.v1.insights_questionnaires_question:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
question_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^GE[0-9a-fA-F]{32}$
nullable: true
description: The SID of the question
question:
type: string
nullable: true
description: The question.
description:
type: string
nullable: true
description: The description for the question.
category:
nullable: true
description: The Category for the question.
answer_set_id:
type: string
nullable: true
description: The answer_set for the question.
allow_na:
type: boolean
nullable: true
description: The flag to enable for disable NA for answer.
usage:
type: integer
default: 0
description: Integer value that tells a particular question is used by how
many questionnaires
answer_set:
nullable: true
description: Set of answers for the question
url:
type: string
format: uri
nullable: true
flex.v1.insights_segments:
type: object
properties:
segment_id:
type: string
nullable: true
description: To unique id of the segment
external_id:
type: string
nullable: true
description: The unique id for the conversation.
queue:
type: string
nullable: true
external_contact:
type: string
nullable: true
external_segment_link_id:
type: string
nullable: true
description: The uuid for the external_segment_link.
date:
type: string
nullable: true
description: The date of the conversation.
account_id:
type: string
nullable: true
description: The unique id for the account.
external_segment_link:
type: string
nullable: true
description: The hyperlink to recording of the task event.
agent_id:
type: string
nullable: true
description: The unique id for the agent.
agent_phone:
type: string
nullable: true
description: The phone number of the agent.
agent_name:
type: string
nullable: true
description: The name of the agent.
agent_team_name:
type: string
nullable: true
description: The team name to which agent belongs.
agent_team_name_in_hierarchy:
type: string
nullable: true
description: he team name to which agent belongs.
agent_link:
type: string
nullable: true
description: The link to the agent conversation.
customer_phone:
type: string
nullable: true
description: The phone number of the customer.
customer_name:
type: string
nullable: true
description: The name of the customer.
customer_link:
type: string
nullable: true
description: The link to the customer conversation.
segment_recording_offset:
type: string
nullable: true
description: The offset value for the recording.
media:
nullable: true
description: The media identifiers of the conversation.
assessment_type:
nullable: true
description: The type of the assessment.
assessment_percentage:
nullable: true
description: The percentage scored on the Assessments.
url:
type: string
format: uri
nullable: true
flex.v1.insights_session:
type: object
properties:
workspace_id:
type: string
nullable: true
description: Unique ID to identify the user's workspace
session_expiry:
type: string
nullable: true
description: The session expiry date and time, given in ISO 8601 format.
session_id:
type: string
nullable: true
description: The unique ID for the session
base_url:
type: string
nullable: true
description: The base URL to fetch reports and dashboards
url:
type: string
format: uri
nullable: true
description: The URL of this resource.
flex.v1.insights_settings_answersets:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
answer_sets:
nullable: true
description: The lis of answer sets
answer_set_categories:
nullable: true
description: The list of answer set categories
not_applicable:
nullable: true
description: The details for not applicable answer set
url:
type: string
format: uri
nullable: true
flex.v1.insights_settings_comment:
type: object
properties:
account_sid:
type: string
minLength: 34
maxLength: 34
pattern: ^AC[0-9a-fA-F]{32}$
nullable: true
description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account)
that created the Flex Insights resource and owns this resource.
comments:
nullable: true
url:
type: string
format: uri
nullable: true
flex.v1.insights_user_roles:
type: object
properties:
roles:
type: array
items:
type: string
nullable: true
description: Flex Insights roles for the user
url:
type: string
format: uri
nullable: true
flex.v1.interaction:
type: object
properties:
sid:
type: string
minLength: 34
maxLength: 34
pattern: ^KD[0-9a-fA-F]{32}$
nullable: true
description: The unique string created by Twilio to identify an Interaction
resource, prefixed with KD.
channel:
nullable: true
description: "A JSON object that defines the Interaction\u2019s communication\
\ channel and includes details about the channel. See the [Outbound SMS](https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions#agent-initiated-outbound-interactions)\