Module Values_2.StartChatContactResponseSource

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 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 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 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 the following topics in the Amazon Connect Administrator Guide: Concepts: Web and mobile messaging capabilities in Amazon Connect Amazon Connect Chat security best practices

Sourcetype nonrec t = {
  1. contactId : Values_0.ContactId.t option;
    (*

    The identifier of this contact within the Amazon Connect instance.

    *)
  2. participantId : Values_0.ParticipantId.t option;
    (*

    The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

    *)
  3. participantToken : Values_0.ParticipantToken.t option;
    (*

    The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

    *)
  4. continuedFromContactId : Values_0.ContactId.t option;
    (*

    The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of Values_0.InternalServiceException.t
  2. | `InvalidParameterException of Values_0.InvalidParameterException.t
  3. | `InvalidRequestException of Values_0.InvalidRequestException.t
  4. | `LimitExceededException of Values_0.LimitExceededException.t
  5. | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?contactId:??? -> ?participantId:??? -> ?participantToken:??? -> ?continuedFromContactId:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `LimitExceededException of Values_0.LimitExceededException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of Values_0.InternalServiceException.t | `InvalidParameterException of Values_0.InvalidParameterException.t | `InvalidRequestException of Values_0.InvalidRequestException.t | `LimitExceededException of Values_0.LimitExceededException.t | `ResourceNotFoundException of Values_0.ResourceNotFoundException.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of Values_0.ContactId.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t