Adds a new participant into an on-going chat contact. For more information, see Customize chat + * flow experiences by integrating custom participants.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, CreateParticipantCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, CreateParticipantCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // CreateParticipantRequest + * InstanceId: "STRING_VALUE", // required + * ContactId: "STRING_VALUE", // required + * ClientToken: "STRING_VALUE", + * ParticipantDetails: { // ParticipantDetailsToAdd + * ParticipantRole: "AGENT" || "CUSTOMER" || "SYSTEM" || "CUSTOM_BOT", + * DisplayName: "STRING_VALUE", + * }, + * }; + * const command = new CreateParticipantCommand(input); + * const response = await client.send(command); + * ``` + * + * @param CreateParticipantCommandInput - {@link CreateParticipantCommandInput} + * @returns {@link CreateParticipantCommandOutput} + * @see {@link CreateParticipantCommandInput} for command's `input` shape. + * @see {@link CreateParticipantCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The service quota has been exceeded.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * + */ +export class CreateParticipantCommand extends $Command< + CreateParticipantCommandInput, + CreateParticipantCommandOutput, + ConnectClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateParticipantCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackThe details to add for the participant.
+ */ +export interface ParticipantDetailsToAdd { + /** + *The role of the participant being added.
+ */ + ParticipantRole?: ParticipantRole | string; + + /** + *The display name of the participant.
+ */ + DisplayName?: string; +} + +/** + * @public + */ +export interface CreateParticipantRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + *The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.
+ */ + ContactId: string | undefined; + + /** + *A unique, case-sensitive identifier that you provide to ensure the idempotency of the + * request. If not provided, the Amazon Web Services + * SDK populates this field. For more information about idempotency, see + * Making retries safe with idempotent APIs.
+ */ + ClientToken?: string; + + /** + *Information identifying the participant.
+ *The only Valid value for ParticipantRole is CUSTOM_BOT.
+ * DisplayName is Required.
The credentials used by the participant.
+ */ +export interface ParticipantTokenCredentials { + /** + *The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat + * participant.
+ */ + ParticipantToken?: string; + + /** + *The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. + * For example, 2019-11-08T02:41:28.172Z.
+ */ + Expiry?: string; +} + +/** + * @public + */ +export interface CreateParticipantResponse { + /** + *The token used by the chat participant to call CreateParticipantConnection. The participant
+ * token is valid for the lifetime of a chat participant.
The identifier for a chat participant. The participantId for a chat participant is the same + * throughout the chat lifecycle.
+ */ + ParticipantId?: string; +} + /** * @public *The outbound caller ID name, number, and outbound whisper flow.
@@ -1818,12 +1918,13 @@ export type BehaviorType = (typeof BehaviorType)[keyof typeof BehaviorType]; /** * @public - *Defines the cross-channel routing behavior that allows an agent working on a contact in - * one channel to be offered a contact from a different channel.
+ *Defines the cross-channel routing behavior that allows an agent working on a contact in one + * channel to be offered a contact from a different channel.
*/ export interface CrossChannelBehavior { /** - *Specifies the other channels that can be routed to an agent handling their current channel.
+ *Specifies the other channels that can be routed to an agent handling their current + * channel.
*/ BehaviorType: BehaviorType | string | undefined; } @@ -6511,9 +6612,9 @@ export interface FilterV2 { export interface MetricFilterV2 { /** *The key to use for filtering data.
- *Valid metric filter keys: INITIATION_METHOD,
- * DISCONNECT_REASON
- *
Valid metric filter keys: INITIATION_METHOD, DISCONNECT_REASON.
+ * These are the same values as the InitiationMethod and DisconnectReason
+ * in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide.
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the - * retrieval of historical metrics data. The time must be later than the start time - * timestamp. It cannot be later than the current timestamp.
+ * retrieval of historical metrics data. The time must be later than the start time timestamp. It + * cannot be later than the current timestamp. *The time range between the start and end time must be less than 24 hours.
*/ EndTime: Date | undefined; @@ -7062,97 +7163,6 @@ export interface ListAgentStatusRequest { AgentStatusTypes?: (AgentStatusType | string)[]; } -/** - * @public - */ -export interface ListAgentStatusResponse { - /** - *If there are additional results, this is the token for the next set of results.
- */ - NextToken?: string; - - /** - *A summary of agent statuses.
- */ - AgentStatusSummaryList?: AgentStatusSummary[]; -} - -/** - * @public - */ -export interface ListApprovedOriginsRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; - - /** - *The token for the next set of results. Use the value returned in the previous - * response in the next request to retrieve the next set of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return per page.
- */ - MaxResults?: number; -} - -/** - * @public - */ -export interface ListApprovedOriginsResponse { - /** - *The approved origins.
- */ - Origins?: string[]; - - /** - *If there are additional results, this is the token for the next set of results.
- */ - NextToken?: string; -} - -/** - * @public - * @enum - */ -export const LexVersion = { - V1: "V1", - V2: "V2", -} as const; - -/** - * @public - */ -export type LexVersion = (typeof LexVersion)[keyof typeof LexVersion]; - -/** - * @public - */ -export interface ListBotsRequest { - /** - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; - - /** - *The token for the next set of results. Use the value returned in the previous - * response in the next request to retrieve the next set of results.
- */ - NextToken?: string; - - /** - *The maximum number of results to return per page.
- */ - MaxResults?: number; - - /** - *The version of Amazon Lex or Amazon Lex V2.
- */ - LexVersion: LexVersion | string | undefined; -} - /** * @internal */ diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index 9f07d6a2e709..349365e61e73 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -5,6 +5,7 @@ import { ConnectServiceException as __BaseException } from "./ConnectServiceExce import { ActionSummary, AgentStatusState, + AgentStatusSummary, Attribute, Channel, ContactFlowModuleState, @@ -50,6 +51,97 @@ import { VocabularyState, } from "./models_0"; +/** + * @public + */ +export interface ListAgentStatusResponse { + /** + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; + + /** + *A summary of agent statuses.
+ */ + AgentStatusSummaryList?: AgentStatusSummary[]; +} + +/** + * @public + */ +export interface ListApprovedOriginsRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return per page.
+ */ + MaxResults?: number; +} + +/** + * @public + */ +export interface ListApprovedOriginsResponse { + /** + *The approved origins.
+ */ + Origins?: string[]; + + /** + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + * @enum + */ +export const LexVersion = { + V1: "V1", + V2: "V2", +} as const; + +/** + * @public + */ +export type LexVersion = (typeof LexVersion)[keyof typeof LexVersion]; + +/** + * @public + */ +export interface ListBotsRequest { + /** + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + *The token for the next set of results. Use the value returned in the previous + * response in the next request to retrieve the next set of results.
+ */ + NextToken?: string; + + /** + *The maximum number of results to return per page.
+ */ + MaxResults?: number; + + /** + *The version of Amazon Lex or Amazon Lex V2.
+ */ + LexVersion: LexVersion | string | undefined; +} + /** * @public *Configuration information of an Amazon Lex or Amazon Lex V2 bot.
@@ -2903,8 +2995,8 @@ export interface SearchVocabulariesResponse { export interface ChatMessage { /** *The type of the content. Supported types are text/plain,
- * text/markdown, application/json, and
- * application/vnd.amazonaws.connect.message.interactive.response.
text/markdown, application/json, and
+ * application/vnd.amazonaws.connect.message.interactive.response.
*/
ContentType: string | undefined;
@@ -2920,8 +3012,8 @@ export interface ChatMessage {
* 12000.
*
* For application/vnd.amazonaws.connect.message.interactive.response, the Length
- * Constraints are Minimum of 1, Maximum of 12288.
For application/vnd.amazonaws.connect.message.interactive.response, the
+ * Length Constraints are Minimum of 1, Maximum of 12288.
The supported chat message content types.
- * Supported types are text/plain,
- * text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and
- * application/vnd.amazonaws.connect.message.interactive.response.
Content types must always contain
- * The supported chat message content types. Supported types are Content types must always contain The type The type of the content. Supported types are The type of the content. Supported types are The content of the chat message. For For For The content of the chat message. For For For Adds a new participant into an on-going chat contact. For more information, see Customize chat\n flow experiences by integrating custom participants. The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported. A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs. Information identifying the participant. The only Valid value for \n The token used by the chat participant to call The identifier for a chat participant. The participantId for a chat participant is the same\n throughout the chat lifecycle. Specifies the other channels that can be routed to an agent handling their current channel. Specifies the other channels that can be routed to an agent handling their current\n channel. Defines the cross-channel routing behavior that allows an agent working on a contact in \n one channel to be offered a contact from a different channel. Defines the cross-channel routing behavior that allows an agent working on a contact in one\n channel to be offered a contact from a different channel. The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time\n timestamp. It cannot be later than the current timestamp. The time range between the start and end time must be less than 24 hours. The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the\n retrieval of historical metrics data. The time must be later than the start time timestamp. It\n cannot be later than the current timestamp. The time range between the start and end time must be less than 24 hours. The start time or end time for an hours of operation. Defines the cross-channel routing behavior for each channel that is enabled for this Routing \n Profile. For example, this allows you to offer an agent a different contact from another channel \n when they are currently working with a contact from a Voice channel. Defines the cross-channel routing behavior for each channel that is enabled for this Routing\n Profile. For example, this allows you to offer an agent a different contact from another channel\n when they are currently working with a contact from a Voice channel. The key to use for filtering data. Valid metric filter keys: The key to use for filtering data. Valid metric filter keys: The customer's details. The role of the participant being added. The display name of the participant. The details to add for the participant. The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat\n participant. The expiration of the token. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ.\n For example, 2019-11-08T02:41:28.172Z. The credentials used by the participant. The supported chat message content types. \n Supported types are Content types must always contain\n The type The supported chat message content types. Supported types are Content types must always contain The type text/plain. You can then put any other supported type in the list. For example, all
- * the following lists are valid because they contain text/plain: [text/plain,
- * text/markdown, application/json], [text/markdown, text/plain],
- * [text/plain, application/json,
+ * text/plain,
+ * text/markdown, application/json,
+ * application/vnd.amazonaws.connect.message.interactive, and
+ * application/vnd.amazonaws.connect.message.interactive.response. text/plain. You can then put any other
+ * supported type in the list. For example, all the following lists are valid because they contain
+ * text/plain: [text/plain, text/markdown, application/json],
+ * [text/markdown, text/plain], [text/plain, application/json,
* application/vnd.amazonaws.connect.message.interactive.response]. application/vnd.amazonaws.connect.message.interactive is required to
diff --git a/clients/client-connect/src/protocols/Aws_restJson1.ts b/clients/client-connect/src/protocols/Aws_restJson1.ts
index 660947af66f1..0087b75c1970 100644
--- a/clients/client-connect/src/protocols/Aws_restJson1.ts
+++ b/clients/client-connect/src/protocols/Aws_restJson1.ts
@@ -75,6 +75,7 @@ import {
CreateIntegrationAssociationCommandInput,
CreateIntegrationAssociationCommandOutput,
} from "../commands/CreateIntegrationAssociationCommand";
+import { CreateParticipantCommandInput, CreateParticipantCommandOutput } from "../commands/CreateParticipantCommand";
import { CreateQueueCommandInput, CreateQueueCommandOutput } from "../commands/CreateQueueCommand";
import { CreateQuickConnectCommandInput, CreateQuickConnectCommandOutput } from "../commands/CreateQuickConnectCommand";
import {
@@ -548,6 +549,7 @@ import {
MonitorCapability,
NotificationRecipientType,
OutboundCallerConfig,
+ ParticipantDetailsToAdd,
PhoneNumberCountryCode,
PhoneNumberQuickConnectConfig,
PhoneNumberType,
@@ -1208,6 +1210,39 @@ export const se_CreateIntegrationAssociationCommand = async (
});
};
+/**
+ * serializeAws_restJson1CreateParticipantCommand
+ */
+export const se_CreateParticipantCommand = async (
+ input: CreateParticipantCommandInput,
+ context: __SerdeContext
+): Promise<__HttpRequest> => {
+ const { hostname, protocol = "https", port, path: basePath } = await context.endpoint();
+ const headers: any = {
+ "content-type": "application/json",
+ };
+ const resolvedPath =
+ `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + "/contact/create-participant";
+ let body: any;
+ body = JSON.stringify(
+ take(input, {
+ ClientToken: [true, (_) => _ ?? generateIdempotencyToken()],
+ ContactId: [],
+ InstanceId: [],
+ ParticipantDetails: (_) => _json(_),
+ })
+ );
+ return new __HttpRequest({
+ protocol,
+ hostname,
+ port,
+ method: "POST",
+ headers,
+ path: resolvedPath,
+ body,
+ });
+};
+
/**
* serializeAws_restJson1CreateQueueCommand
*/
@@ -7361,6 +7396,69 @@ const de_CreateIntegrationAssociationCommandError = async (
}
};
+/**
+ * deserializeAws_restJson1CreateParticipantCommand
+ */
+export const de_CreateParticipantCommand = async (
+ output: __HttpResponse,
+ context: __SerdeContext
+): Promisetext/plain,\n text/markdown, application/json, and \n application/vnd.amazonaws.connect.message.interactive.response.text/plain,\n text/markdown, application/json, and\n application/vnd.amazonaws.connect.message.interactive.response.\n
",
+ "smithy.api#documentation": "text/plain and text/markdown, the Length Constraints are\n Minimum of 1, Maximum of 1024. application/json, the Length Constraints are Minimum of 1, Maximum of\n 12000. application/vnd.amazonaws.connect.message.interactive.response, the Length\n Constraints are Minimum of 1, Maximum of 12288.\n
",
"smithy.api#required": {}
}
}
@@ -4420,6 +4423,99 @@
"smithy.api#output": {}
}
},
+ "com.amazonaws.connect#CreateParticipant": {
+ "type": "operation",
+ "input": {
+ "target": "com.amazonaws.connect#CreateParticipantRequest"
+ },
+ "output": {
+ "target": "com.amazonaws.connect#CreateParticipantResponse"
+ },
+ "errors": [
+ {
+ "target": "com.amazonaws.connect#InternalServiceException"
+ },
+ {
+ "target": "com.amazonaws.connect#InvalidParameterException"
+ },
+ {
+ "target": "com.amazonaws.connect#InvalidRequestException"
+ },
+ {
+ "target": "com.amazonaws.connect#ResourceNotFoundException"
+ },
+ {
+ "target": "com.amazonaws.connect#ServiceQuotaExceededException"
+ },
+ {
+ "target": "com.amazonaws.connect#ThrottlingException"
+ }
+ ],
+ "traits": {
+ "smithy.api#documentation": "text/plain and text/markdown, the Length Constraints are\n Minimum of 1, Maximum of 1024. application/json, the Length Constraints are Minimum of 1, Maximum of\n 12000. application/vnd.amazonaws.connect.message.interactive.response, the\n Length Constraints are Minimum of 1, Maximum of 12288.ParticipantRole is CUSTOM_BOT. DisplayName is Required.CreateParticipantConnection. The participant\n token is valid for the lifetime of a chat participant.INITIATION_METHOD,\n DISCONNECT_REASON\n INITIATION_METHOD, DISCONNECT_REASON.\n These are the same values as the InitiationMethod and DisconnectReason\n in the contact record. For more information, see ContactTraceRecord in the Amazon Connect Administrator's Guide. text/plain,\n text/markdown, application/json, application/vnd.amazonaws.connect.message.interactive, and \n application/vnd.amazonaws.connect.message.interactive.response. text/plain. You can then put any other supported type in the list. For example, all\n the following lists are valid because they contain text/plain: [text/plain,\n text/markdown, application/json], [text/markdown, text/plain],\n [text/plain, application/json,\n application/vnd.amazonaws.connect.message.interactive.response]. application/vnd.amazonaws.connect.message.interactive is required to\n use the Show\n view flow block.text/plain,\n text/markdown, application/json,\n application/vnd.amazonaws.connect.message.interactive, and\n application/vnd.amazonaws.connect.message.interactive.response. text/plain. You can then put any other\n supported type in the list. For example, all the following lists are valid because they contain\n text/plain: [text/plain, text/markdown, application/json],\n [text/markdown, text/plain], [text/plain, application/json,\n application/vnd.amazonaws.connect.message.interactive.response]. application/vnd.amazonaws.connect.message.interactive is required to\n use the Show\n view flow block.