@aws-sdk/client-connect 3.835.0 → 3.840.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +44 -10
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/models/models_1.js +7 -7
- package/dist-es/protocols/Aws_restJson1.js +33 -0
- package/dist-types/commands/CreateContactCommand.d.ts +22 -5
- package/dist-types/commands/DescribeContactCommand.d.ts +34 -0
- package/dist-types/commands/DescribeRoutingProfileCommand.d.ts +5 -0
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +2 -1
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +1 -2
- package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +5 -0
- package/dist-types/commands/UpdateParticipantRoleConfigCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +3 -2
- package/dist-types/models/models_1.d.ts +190 -111
- package/dist-types/models/models_2.d.ts +118 -65
- package/dist-types/models/models_3.d.ts +86 -16
- package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateParticipantRoleConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/models/models_1.d.ts +35 -29
- package/dist-types/ts3.4/models/models_2.d.ts +20 -12
- package/dist-types/ts3.4/models/models_3.d.ts +15 -0
- package/package.json +18 -18
|
@@ -461,6 +461,139 @@ export declare const AnsweringMachineDetectionStatus: {
|
|
|
461
461
|
* @public
|
|
462
462
|
*/
|
|
463
463
|
export type AnsweringMachineDetectionStatus = (typeof AnsweringMachineDetectionStatus)[keyof typeof AnsweringMachineDetectionStatus];
|
|
464
|
+
/**
|
|
465
|
+
* @public
|
|
466
|
+
* @enum
|
|
467
|
+
*/
|
|
468
|
+
export declare const ParticipantType: {
|
|
469
|
+
readonly AGENT: "AGENT";
|
|
470
|
+
readonly ALL: "ALL";
|
|
471
|
+
readonly CUSTOMER: "CUSTOMER";
|
|
472
|
+
readonly MANAGER: "MANAGER";
|
|
473
|
+
readonly THIRDPARTY: "THIRDPARTY";
|
|
474
|
+
};
|
|
475
|
+
/**
|
|
476
|
+
* @public
|
|
477
|
+
*/
|
|
478
|
+
export type ParticipantType = (typeof ParticipantType)[keyof typeof ParticipantType];
|
|
479
|
+
/**
|
|
480
|
+
* <p>Information about a participant's interactions in a contact.</p>
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
export interface ParticipantMetrics {
|
|
484
|
+
/**
|
|
485
|
+
* <p>The Participant's ID.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
ParticipantId?: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* <p>Information about the conversation participant. Following are the participant types: [Agent, Customer, Supervisor].</p>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
ParticipantType?: ParticipantType | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* <p>A boolean flag indicating whether the chat conversation was abandoned by a Participant.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
ConversationAbandon?: boolean | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>Number of chat messages sent by Participant.</p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
MessagesSent?: number | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* <p>Number of chat messages sent by Participant.</p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
NumResponses?: number | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* <p>Number of chat characters sent by Participant.</p>
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
MessageLengthInChars?: number | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* <p>Total chat response time by Participant.</p>
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
TotalResponseTimeInMillis?: number | undefined;
|
|
519
|
+
/**
|
|
520
|
+
* <p>Maximum chat response time by Participant.</p>
|
|
521
|
+
* @public
|
|
522
|
+
*/
|
|
523
|
+
MaxResponseTimeInMillis?: number | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* <p>Timestamp of last chat message by Participant.</p>
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
LastMessageTimestamp?: Date | undefined;
|
|
529
|
+
}
|
|
530
|
+
/**
|
|
531
|
+
* <p>Information about the overall participant interactions at the contact level.</p>
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
export interface ChatContactMetrics {
|
|
535
|
+
/**
|
|
536
|
+
* <p>A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this contact.</p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
MultiParty?: boolean | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* <p>The number of chat messages on the contact.</p>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
TotalMessages?: number | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The total number of bot and automated messages on a chat contact.</p>
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
TotalBotMessages?: number | undefined;
|
|
550
|
+
/**
|
|
551
|
+
* <p>The total number of characters from bot and automated messages on a chat contact.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
TotalBotMessageLengthInChars?: number | undefined;
|
|
555
|
+
/**
|
|
556
|
+
* <p>The time it took for a contact to end after the last customer message.</p>
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
ConversationCloseTimeInMillis?: number | undefined;
|
|
560
|
+
/**
|
|
561
|
+
* <p>The number of conversation turns in a chat contact, which represents the back-and-forth exchanges between customer and other participants.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
ConversationTurnCount?: number | undefined;
|
|
565
|
+
/**
|
|
566
|
+
* <p>The agent first response timestamp for a chat contact.</p>
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
AgentFirstResponseTimestamp?: Date | undefined;
|
|
570
|
+
/**
|
|
571
|
+
* <p>The time for an agent to respond after obtaining a chat contact.</p>
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
AgentFirstResponseTimeInMillis?: number | undefined;
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
* <p>Information about how agent, bot, and customer interact in a chat contact.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
export interface ChatMetrics {
|
|
581
|
+
/**
|
|
582
|
+
* <p>Information about the overall participant interactions at the contact level.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
ChatContactMetrics?: ChatContactMetrics | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>Information about agent interactions in a contact.</p>
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
AgentMetrics?: ParticipantMetrics | undefined;
|
|
591
|
+
/**
|
|
592
|
+
* <p>Information about customer interactions in a contact.</p>
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
CustomerMetrics?: ParticipantMetrics | undefined;
|
|
596
|
+
}
|
|
464
597
|
/**
|
|
465
598
|
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed
|
|
466
599
|
* within the contact. This object is used only for task contacts. </p>
|
|
@@ -656,21 +789,6 @@ export declare const MediaStreamType: {
|
|
|
656
789
|
* @public
|
|
657
790
|
*/
|
|
658
791
|
export type MediaStreamType = (typeof MediaStreamType)[keyof typeof MediaStreamType];
|
|
659
|
-
/**
|
|
660
|
-
* @public
|
|
661
|
-
* @enum
|
|
662
|
-
*/
|
|
663
|
-
export declare const ParticipantType: {
|
|
664
|
-
readonly AGENT: "AGENT";
|
|
665
|
-
readonly ALL: "ALL";
|
|
666
|
-
readonly CUSTOMER: "CUSTOMER";
|
|
667
|
-
readonly MANAGER: "MANAGER";
|
|
668
|
-
readonly THIRDPARTY: "THIRDPARTY";
|
|
669
|
-
};
|
|
670
|
-
/**
|
|
671
|
-
* @public
|
|
672
|
-
*/
|
|
673
|
-
export type ParticipantType = (typeof ParticipantType)[keyof typeof ParticipantType];
|
|
674
792
|
/**
|
|
675
793
|
* @public
|
|
676
794
|
* @enum
|
|
@@ -1342,7 +1460,7 @@ export interface DescribeEmailAddressResponse {
|
|
|
1342
1460
|
*/
|
|
1343
1461
|
EmailAddressArn?: string | undefined;
|
|
1344
1462
|
/**
|
|
1345
|
-
* <p>The email address
|
|
1463
|
+
* <p>The email address, including the domain.</p>
|
|
1346
1464
|
* @public
|
|
1347
1465
|
*/
|
|
1348
1466
|
EmailAddress?: string | undefined;
|
|
@@ -5425,8 +5543,8 @@ export interface GetMetricDataV2Request {
|
|
|
5425
5543
|
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
|
|
5426
5544
|
* <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> |
|
|
5427
5545
|
* <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> |
|
|
5428
|
-
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code>
|
|
5429
|
-
* <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
5546
|
+
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CAMPAIGN_EXCLUDED_EVENT_TYPE </code> |
|
|
5547
|
+
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
5430
5548
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
5431
5549
|
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
|
|
5432
5550
|
* <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> |
|
|
@@ -5489,6 +5607,7 @@ export interface GetMetricDataV2Request {
|
|
|
5489
5607
|
* <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> |
|
|
5490
5608
|
* <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> |
|
|
5491
5609
|
* <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
|
|
5610
|
+
* <code>CAMPAIGN_EXCLUDED_EVENT_TYPE</code> | <code>CAMPAIGN_EXECUTION_TIMESTAMP</code> |
|
|
5492
5611
|
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
5493
5612
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
5494
5613
|
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
|
|
@@ -5962,6 +6081,16 @@ export interface GetMetricDataV2Request {
|
|
|
5962
6081
|
* interactions</a>
|
|
5963
6082
|
* </p>
|
|
5964
6083
|
* </dd>
|
|
6084
|
+
* <dt>CAMPAIGN_PROGRESS_RATE</dt>
|
|
6085
|
+
* <dd>
|
|
6086
|
+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
|
|
6087
|
+
* It is not available for event triggered campaigns.</p>
|
|
6088
|
+
* <p>Unit: Percent</p>
|
|
6089
|
+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
|
|
6090
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate">Campaign
|
|
6091
|
+
* progress rate</a>
|
|
6092
|
+
* </p>
|
|
6093
|
+
* </dd>
|
|
5965
6094
|
* <dt>CAMPAIGN_SEND_ATTEMPTS</dt>
|
|
5966
6095
|
* <dd>
|
|
5967
6096
|
* <p>This metric is available only for outbound campaigns.</p>
|
|
@@ -5971,6 +6100,17 @@ export interface GetMetricDataV2Request {
|
|
|
5971
6100
|
* attempts</a>
|
|
5972
6101
|
* </p>
|
|
5973
6102
|
* </dd>
|
|
6103
|
+
* <dt>CAMPAIGN_SEND_EXCLUSIONS</dt>
|
|
6104
|
+
* <dd>
|
|
6105
|
+
* <p>This metric is available only for outbound campaigns.</p>
|
|
6106
|
+
* <p>Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE</p>
|
|
6107
|
+
* <p>Unit: Count</p>
|
|
6108
|
+
* <p>Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution
|
|
6109
|
+
* Timestamp</p>
|
|
6110
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions">Campaign
|
|
6111
|
+
* send exclusions</a>
|
|
6112
|
+
* </p>
|
|
6113
|
+
* </dd>
|
|
5974
6114
|
* <dt>CASES_CREATED</dt>
|
|
5975
6115
|
* <dd>
|
|
5976
6116
|
* <p>Unit: Count</p>
|
|
@@ -6359,6 +6499,38 @@ export interface GetMetricDataV2Request {
|
|
|
6359
6499
|
* talk time percent</a>
|
|
6360
6500
|
* </p>
|
|
6361
6501
|
* </dd>
|
|
6502
|
+
* <dt>RECIPIENTS_ATTEMPTED</dt>
|
|
6503
|
+
* <dd>
|
|
6504
|
+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
|
|
6505
|
+
* It is not available for event triggered campaigns.</p>
|
|
6506
|
+
* <p>Unit: Count</p>
|
|
6507
|
+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
|
|
6508
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted">Recipients
|
|
6509
|
+
* attempted</a>
|
|
6510
|
+
* </p>
|
|
6511
|
+
* </dd>
|
|
6512
|
+
* <dt>RECIPIENTS_INTERACTED</dt>
|
|
6513
|
+
* <dd>
|
|
6514
|
+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
|
|
6515
|
+
* It is not available for event triggered campaigns.</p>
|
|
6516
|
+
* <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p>
|
|
6517
|
+
* <p>Unit: Count</p>
|
|
6518
|
+
* <p>Valid groupings and filters: Campaign, Channel,
|
|
6519
|
+
* contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp</p>
|
|
6520
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted">Recipients
|
|
6521
|
+
* interacted</a>
|
|
6522
|
+
* </p>
|
|
6523
|
+
* </dd>
|
|
6524
|
+
* <dt>RECIPIENTS_TARGETED</dt>
|
|
6525
|
+
* <dd>
|
|
6526
|
+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
|
|
6527
|
+
* It is not available for event triggered campaigns.</p>
|
|
6528
|
+
* <p>Unit: Count</p>
|
|
6529
|
+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
|
|
6530
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted">Recipients
|
|
6531
|
+
* targeted</a>
|
|
6532
|
+
* </p>
|
|
6533
|
+
* </dd>
|
|
6362
6534
|
* <dt>REOPENED_CASE_ACTIONS</dt>
|
|
6363
6535
|
* <dd>
|
|
6364
6536
|
* <p>Unit: Count</p>
|
|
@@ -8746,99 +8918,6 @@ export interface ListPhoneNumbersRequest {
|
|
|
8746
8918
|
*/
|
|
8747
8919
|
MaxResults?: number | undefined;
|
|
8748
8920
|
}
|
|
8749
|
-
/**
|
|
8750
|
-
* <p>Contains summary information about a phone number for a contact center.</p>
|
|
8751
|
-
* @public
|
|
8752
|
-
*/
|
|
8753
|
-
export interface PhoneNumberSummary {
|
|
8754
|
-
/**
|
|
8755
|
-
* <p>The identifier of the phone number.</p>
|
|
8756
|
-
* @public
|
|
8757
|
-
*/
|
|
8758
|
-
Id?: string | undefined;
|
|
8759
|
-
/**
|
|
8760
|
-
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
8761
|
-
* @public
|
|
8762
|
-
*/
|
|
8763
|
-
Arn?: string | undefined;
|
|
8764
|
-
/**
|
|
8765
|
-
* <p>The phone number.</p>
|
|
8766
|
-
* @public
|
|
8767
|
-
*/
|
|
8768
|
-
PhoneNumber?: string | undefined;
|
|
8769
|
-
/**
|
|
8770
|
-
* <p>The type of phone number.</p>
|
|
8771
|
-
* @public
|
|
8772
|
-
*/
|
|
8773
|
-
PhoneNumberType?: PhoneNumberType | undefined;
|
|
8774
|
-
/**
|
|
8775
|
-
* <p>The ISO country code.</p>
|
|
8776
|
-
* @public
|
|
8777
|
-
*/
|
|
8778
|
-
PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
|
|
8779
|
-
}
|
|
8780
|
-
/**
|
|
8781
|
-
* @public
|
|
8782
|
-
*/
|
|
8783
|
-
export interface ListPhoneNumbersResponse {
|
|
8784
|
-
/**
|
|
8785
|
-
* <p>Information about the phone numbers.</p>
|
|
8786
|
-
* @public
|
|
8787
|
-
*/
|
|
8788
|
-
PhoneNumberSummaryList?: PhoneNumberSummary[] | undefined;
|
|
8789
|
-
/**
|
|
8790
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8791
|
-
* @public
|
|
8792
|
-
*/
|
|
8793
|
-
NextToken?: string | undefined;
|
|
8794
|
-
}
|
|
8795
|
-
/**
|
|
8796
|
-
* @public
|
|
8797
|
-
*/
|
|
8798
|
-
export interface ListPhoneNumbersV2Request {
|
|
8799
|
-
/**
|
|
8800
|
-
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both <code>TargetArn</code> and <code>InstanceId</code> input are not
|
|
8801
|
-
* provided, this API lists numbers claimed to all the Amazon Connect instances belonging to
|
|
8802
|
-
* your account in the same Amazon Web Services Region as the request.</p>
|
|
8803
|
-
* @public
|
|
8804
|
-
*/
|
|
8805
|
-
TargetArn?: string | undefined;
|
|
8806
|
-
/**
|
|
8807
|
-
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
8808
|
-
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
8809
|
-
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <code>TargetArn</code> and <code>InstanceId</code> are not
|
|
8810
|
-
* provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in
|
|
8811
|
-
* the same AWS Region as the request.</p>
|
|
8812
|
-
* @public
|
|
8813
|
-
*/
|
|
8814
|
-
InstanceId?: string | undefined;
|
|
8815
|
-
/**
|
|
8816
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8817
|
-
* @public
|
|
8818
|
-
*/
|
|
8819
|
-
MaxResults?: number | undefined;
|
|
8820
|
-
/**
|
|
8821
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8822
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8823
|
-
* @public
|
|
8824
|
-
*/
|
|
8825
|
-
NextToken?: string | undefined;
|
|
8826
|
-
/**
|
|
8827
|
-
* <p>The ISO country code.</p>
|
|
8828
|
-
* @public
|
|
8829
|
-
*/
|
|
8830
|
-
PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
|
|
8831
|
-
/**
|
|
8832
|
-
* <p>The type of phone number.</p>
|
|
8833
|
-
* @public
|
|
8834
|
-
*/
|
|
8835
|
-
PhoneNumberTypes?: PhoneNumberType[] | undefined;
|
|
8836
|
-
/**
|
|
8837
|
-
* <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
|
|
8838
|
-
* @public
|
|
8839
|
-
*/
|
|
8840
|
-
PhoneNumberPrefix?: string | undefined;
|
|
8841
|
-
}
|
|
8842
8921
|
/**
|
|
8843
8922
|
* @internal
|
|
8844
8923
|
*/
|
|
@@ -2,6 +2,99 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
3
|
import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MonitorCapability, ParticipantRole, QuickConnectType, Reference, RehydrationType, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
4
|
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* <p>Contains summary information about a phone number for a contact center.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface PhoneNumberSummary {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The identifier of the phone number.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
Id?: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
Arn?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The phone number.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
PhoneNumber?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The type of phone number.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
PhoneNumberType?: PhoneNumberType | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The ISO country code.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export interface ListPhoneNumbersResponse {
|
|
40
|
+
/**
|
|
41
|
+
* <p>Information about the phone numbers.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
PhoneNumberSummaryList?: PhoneNumberSummary[] | undefined;
|
|
45
|
+
/**
|
|
46
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
NextToken?: string | undefined;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
export interface ListPhoneNumbersV2Request {
|
|
55
|
+
/**
|
|
56
|
+
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both <code>TargetArn</code> and <code>InstanceId</code> input are not
|
|
57
|
+
* provided, this API lists numbers claimed to all the Amazon Connect instances belonging to
|
|
58
|
+
* your account in the same Amazon Web Services Region as the request.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
TargetArn?: string | undefined;
|
|
62
|
+
/**
|
|
63
|
+
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
64
|
+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
65
|
+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <code>TargetArn</code> and <code>InstanceId</code> are not
|
|
66
|
+
* provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in
|
|
67
|
+
* the same AWS Region as the request.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
InstanceId?: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The maximum number of results to return per page.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
MaxResults?: number | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
78
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
NextToken?: string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* <p>The ISO country code.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p>The type of phone number.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
PhoneNumberTypes?: PhoneNumberType[] | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <p>The prefix of the phone number. If provided, it must contain <code>+</code> as part of the country code.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
PhoneNumberPrefix?: string | undefined;
|
|
97
|
+
}
|
|
5
98
|
/**
|
|
6
99
|
* <p>Information about phone numbers that have been claimed to your Amazon Connect instance
|
|
7
100
|
* or traffic distribution group.</p>
|
|
@@ -3141,7 +3234,7 @@ export interface EmailAddressMetadata {
|
|
|
3141
3234
|
*/
|
|
3142
3235
|
EmailAddressArn?: string | undefined;
|
|
3143
3236
|
/**
|
|
3144
|
-
* <p>The email address
|
|
3237
|
+
* <p>The email address, including the domain.</p>
|
|
3145
3238
|
* @public
|
|
3146
3239
|
*/
|
|
3147
3240
|
EmailAddress?: string | undefined;
|
|
@@ -4349,12 +4442,12 @@ export interface SendChatIntegrationEventResponse {
|
|
|
4349
4442
|
NewChatCreated?: boolean | undefined;
|
|
4350
4443
|
}
|
|
4351
4444
|
/**
|
|
4352
|
-
* <p>Contains information about a source or destination email address
|
|
4445
|
+
* <p>Contains information about a source or destination email address.</p>
|
|
4353
4446
|
* @public
|
|
4354
4447
|
*/
|
|
4355
4448
|
export interface EmailAddressInfo {
|
|
4356
4449
|
/**
|
|
4357
|
-
* <p>The email address
|
|
4450
|
+
* <p>The email address, including the domain.</p>
|
|
4358
4451
|
* @public
|
|
4359
4452
|
*/
|
|
4360
4453
|
EmailAddress: string | undefined;
|
|
@@ -4365,12 +4458,15 @@ export interface EmailAddressInfo {
|
|
|
4365
4458
|
DisplayName?: string | undefined;
|
|
4366
4459
|
}
|
|
4367
4460
|
/**
|
|
4368
|
-
* <p>
|
|
4461
|
+
* <p>Information about the additional recipients of outbound email.</p>
|
|
4369
4462
|
* @public
|
|
4370
4463
|
*/
|
|
4371
4464
|
export interface OutboundAdditionalRecipients {
|
|
4372
4465
|
/**
|
|
4373
|
-
* <p>
|
|
4466
|
+
* <p>Information about the <b>additional</b> CC email address
|
|
4467
|
+
* recipients. Email recipients are limited to 50 total addresses: 1 required recipient in the
|
|
4468
|
+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody">DestinationEmailAddress</a> field and up to 49 recipients in the 'CcEmailAddresses'
|
|
4469
|
+
* field.</p>
|
|
4374
4470
|
* @public
|
|
4375
4471
|
*/
|
|
4376
4472
|
CcEmailAddresses?: EmailAddressInfo[] | undefined;
|
|
@@ -4929,17 +5025,29 @@ export interface StartContactStreamingResponse {
|
|
|
4929
5025
|
StreamingId: string | undefined;
|
|
4930
5026
|
}
|
|
4931
5027
|
/**
|
|
4932
|
-
* <p>
|
|
5028
|
+
* <p>Information about the additional TO and CC recipients of an inbound email contact.</p>
|
|
5029
|
+
* <note>
|
|
5030
|
+
* <p>You can include up to 50 email addresses in total, distributed across <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartEmailContact.html#API_StartEmailContact_RequestBody">DestinationEmailAddress</a>, <code>ToAddresses</code>, and <code>CcAddresses</code>. This
|
|
5031
|
+
* total must include one required <code>DestinationEmailAddress</code>. You can then specify up to
|
|
5032
|
+
* 49 addresses allocated across <code>ToAddresses</code> and <code>CcAddresses</code> as
|
|
5033
|
+
* needed.</p>
|
|
5034
|
+
* </note>
|
|
4933
5035
|
* @public
|
|
4934
5036
|
*/
|
|
4935
5037
|
export interface InboundAdditionalRecipients {
|
|
4936
5038
|
/**
|
|
4937
|
-
* <p>The additional recipients information present in to list
|
|
5039
|
+
* <p>The <b>additional</b> recipients information present in to list.
|
|
5040
|
+
* You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify
|
|
5041
|
+
* up to 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>),
|
|
5042
|
+
* for a total of 50 recipients.</p>
|
|
4938
5043
|
* @public
|
|
4939
5044
|
*/
|
|
4940
5045
|
ToAddresses?: EmailAddressInfo[] | undefined;
|
|
4941
5046
|
/**
|
|
4942
|
-
* <p>The additional recipients information present in cc list
|
|
5047
|
+
* <p>The <b>additional</b> recipients information present in cc list.
|
|
5048
|
+
* You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify
|
|
5049
|
+
* up to 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>),
|
|
5050
|
+
* for a total of 50 recipients.</p>
|
|
4943
5051
|
* @public
|
|
4944
5052
|
*/
|
|
4945
5053
|
CcAddresses?: EmailAddressInfo[] | undefined;
|
|
@@ -5063,7 +5171,7 @@ export interface StartOutboundEmailContactRequest {
|
|
|
5063
5171
|
*/
|
|
5064
5172
|
ContactId: string | undefined;
|
|
5065
5173
|
/**
|
|
5066
|
-
* <p>The email address associated with the instance.</p>
|
|
5174
|
+
* <p>The email address associated with the Amazon Connect instance.</p>
|
|
5067
5175
|
* @public
|
|
5068
5176
|
*/
|
|
5069
5177
|
FromEmailAddress?: EmailAddressInfo | undefined;
|
|
@@ -5073,7 +5181,7 @@ export interface StartOutboundEmailContactRequest {
|
|
|
5073
5181
|
*/
|
|
5074
5182
|
DestinationEmailAddress: EmailAddressInfo | undefined;
|
|
5075
5183
|
/**
|
|
5076
|
-
* <p>The
|
|
5184
|
+
* <p>The additional recipients address of email in CC.</p>
|
|
5077
5185
|
* @public
|
|
5078
5186
|
*/
|
|
5079
5187
|
AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
|
|
@@ -6662,61 +6770,6 @@ export declare namespace UpdateParticipantRoleConfigChannelInfo {
|
|
|
6662
6770
|
}
|
|
6663
6771
|
const visit: <T>(value: UpdateParticipantRoleConfigChannelInfo, visitor: Visitor<T>) => T;
|
|
6664
6772
|
}
|
|
6665
|
-
/**
|
|
6666
|
-
* @public
|
|
6667
|
-
*/
|
|
6668
|
-
export interface UpdateParticipantRoleConfigRequest {
|
|
6669
|
-
/**
|
|
6670
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6671
|
-
* @public
|
|
6672
|
-
*/
|
|
6673
|
-
InstanceId: string | undefined;
|
|
6674
|
-
/**
|
|
6675
|
-
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
6676
|
-
* @public
|
|
6677
|
-
*/
|
|
6678
|
-
ContactId: string | undefined;
|
|
6679
|
-
/**
|
|
6680
|
-
* <p>The Amazon Connect channel you want to configure.</p>
|
|
6681
|
-
* @public
|
|
6682
|
-
*/
|
|
6683
|
-
ChannelConfiguration: UpdateParticipantRoleConfigChannelInfo | undefined;
|
|
6684
|
-
}
|
|
6685
|
-
/**
|
|
6686
|
-
* @public
|
|
6687
|
-
*/
|
|
6688
|
-
export interface UpdateParticipantRoleConfigResponse {
|
|
6689
|
-
}
|
|
6690
|
-
/**
|
|
6691
|
-
* @public
|
|
6692
|
-
*/
|
|
6693
|
-
export interface UpdatePhoneNumberRequest {
|
|
6694
|
-
/**
|
|
6695
|
-
* <p>A unique identifier for the phone number.</p>
|
|
6696
|
-
* @public
|
|
6697
|
-
*/
|
|
6698
|
-
PhoneNumberId: string | undefined;
|
|
6699
|
-
/**
|
|
6700
|
-
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
6701
|
-
* @public
|
|
6702
|
-
*/
|
|
6703
|
-
TargetArn?: string | undefined;
|
|
6704
|
-
/**
|
|
6705
|
-
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
6706
|
-
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
6707
|
-
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
|
|
6708
|
-
* @public
|
|
6709
|
-
*/
|
|
6710
|
-
InstanceId?: string | undefined;
|
|
6711
|
-
/**
|
|
6712
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6713
|
-
* request. If not provided, the Amazon Web Services
|
|
6714
|
-
* SDK populates this field. For more information about idempotency, see
|
|
6715
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6716
|
-
* @public
|
|
6717
|
-
*/
|
|
6718
|
-
ClientToken?: string | undefined;
|
|
6719
|
-
}
|
|
6720
6773
|
/**
|
|
6721
6774
|
* @internal
|
|
6722
6775
|
*/
|