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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package connect
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/connect/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Initiates a flow to start a new chat for the customer. Response of this API
// provides a token required to obtain credentials from the
// CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
// API in the Amazon Connect Participant Service. When a new chat contact is
// successfully created, clients must subscribe to the participant’s connection for
// the created chat within 5 minutes. This is achieved by invoking
// CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
// with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following
// situations:
// - API rate limit is exceeded. API TPS throttling returns a TooManyRequests
// exception.
// - The quota for concurrent active chats (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html)
// is exceeded. Active chat throttling returns a LimitExceededException .
//
// If you use the ChatDurationInMinutes parameter and receive a 400 error, your
// account may not support the ability to configure custom chat durations. For more
// information, contact Amazon Web Services Support. For more information about
// chat, see Chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat.html)
// in the Amazon Connect Administrator Guide.
func (c *Client) StartChatContact(ctx context.Context, params *StartChatContactInput, optFns ...func(*Options)) (*StartChatContactOutput, error) {
if params == nil {
params = &StartChatContactInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartChatContact", params, optFns, c.addOperationStartChatContactMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartChatContactOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartChatContactInput struct {
// The identifier of the flow for initiating the chat. To see the ContactFlowId in
// the Amazon Connect admin website, on the navigation menu go to Routing, Contact
// Flows. Choose the flow. On the flow page, under the name of the flow, choose
// Show additional flow information. The ContactFlowId is the last part of the ARN,
// shown here in bold:
// arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx
//
// This member is required.
ContactFlowId *string
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
//
// This member is required.
InstanceId *string
// Information identifying the participant.
//
// This member is required.
ParticipantDetails *types.ParticipantDetails
// A custom key-value pair using an attribute map. The attributes are standard
// Amazon Connect attributes. They can be accessed in flows just like any other
// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
// pairs per contact. Attribute keys can include only alphanumeric, dash, and
// underscore characters.
Attributes map[string]string
// The total duration of the newly started chat session. If not specified, the
// chat session duration defaults to 25 hour. The minimum configurable time is 60
// minutes. The maximum configurable time is 10,080 minutes (7 days).
ChatDurationInMinutes *int32
// 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 (https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)
// .
ClientToken *string
// The initial message to be sent to the newly created chat.
InitialMessage *types.ChatMessage
// Enable persistent chats. For more information about enabling persistent chat,
// and for example use cases and how to configure for them, see Enable persistent
// chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html)
// .
PersistentChat *types.PersistentChat
// The unique identifier for an Amazon Connect contact. This identifier is related
// to the chat starting. You cannot provide data for both RelatedContactId and
// PersistentChat.
RelatedContactId *string
// A set of system defined key-value pairs stored on individual contact segments
// using an attribute map. The attributes are standard Amazon Connect attributes.
// They can be accessed in flows. Attribute keys can include only alphanumeric, -,
// and _. This field can be used to show channel subtype, such as connect:Guide .
// The types application/vnd.amazonaws.connect.message.interactive and
// application/vnd.amazonaws.connect.message.interactive.response must be present
// in the SupportedMessagingContentTypes field of this API in order to set
// SegmentAttributes as { "connect:Subtype": {"valueString" : "connect:Guide" }} .
SegmentAttributes map[string]types.SegmentAttributeValue
// 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 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] . The type
// application/vnd.amazonaws.connect.message.interactive is required to use the
// Show view (https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html)
// flow block.
SupportedMessagingContentTypes []string
noSmithyDocumentSerde
}
type StartChatContactOutput struct {
// The identifier of this contact within the Amazon Connect instance.
ContactId *string
// The contactId from which a persistent chat session is started. This field is
// populated only for persistent chats.
ContinuedFromContactId *string
// The identifier for a chat participant. The participantId for a chat participant
// is the same throughout the chat lifecycle.
ParticipantId *string
// The token used by the chat participant to call CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
// . The participant token is valid for the lifetime of a chat participant.
ParticipantToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartChatContactMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartChatContact{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartChatContact{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "StartChatContact"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addIdempotencyToken_opStartChatContactMiddleware(stack, options); err != nil {
return err
}
if err = addOpStartChatContactValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartChatContact(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
type idempotencyToken_initializeOpStartChatContact struct {
tokenProvider IdempotencyTokenProvider
}
func (*idempotencyToken_initializeOpStartChatContact) ID() string {
return "OperationIdempotencyTokenAutoFill"
}
func (m *idempotencyToken_initializeOpStartChatContact) HandleInitialize(ctx context.Context, in middleware.InitializeInput, next middleware.InitializeHandler) (
out middleware.InitializeOutput, metadata middleware.Metadata, err error,
) {
if m.tokenProvider == nil {
return next.HandleInitialize(ctx, in)
}
input, ok := in.Parameters.(*StartChatContactInput)
if !ok {
return out, metadata, fmt.Errorf("expected middleware input to be of type *StartChatContactInput ")
}
if input.ClientToken == nil {
t, err := m.tokenProvider.GetIdempotencyToken()
if err != nil {
return out, metadata, err
}
input.ClientToken = &t
}
return next.HandleInitialize(ctx, in)
}
func addIdempotencyToken_opStartChatContactMiddleware(stack *middleware.Stack, cfg Options) error {
return stack.Initialize.Add(&idempotencyToken_initializeOpStartChatContact{tokenProvider: cfg.IdempotencyTokenProvider}, middleware.Before)
}
func newServiceMetadataMiddleware_opStartChatContact(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "StartChatContact",
}
}
|