Module Values_2.StartOutboundChatContactRequestSource

Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the ContactId of the outbound SMS or WhatsApp contact created. SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new contact created. This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the StartOutboundChatContact Flow Action. For more information about using SMS or WhatsApp in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide: Set up SMS messaging Request an SMS-enabled phone number through Amazon Web Services End User Messaging SMS Set up WhatsApp Business messaging

Sourcetype nonrec t = {
  1. sourceEndpoint : Values_0.Endpoint.t;
  2. destinationEndpoint : Values_0.Endpoint.t;
  3. instanceId : Values_0.InstanceId.t;
    (*

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    *)
  4. segmentAttributes : Values_0.SegmentAttributes.t;
    (*

    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:SMS and connect:WhatsApp.

    *)
  5. attributes : Values_0.Attributes.t option;
    (*

    A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

    *)
  6. contactFlowId : Values_0.ContactFlowId.t;
    (*

    The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, 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/123ec456-a007-89c0-1234-xxxxxxxxxxxx

    *)
  7. chatDurationInMinutes : Values_0.ChatDurationInMinutes.t option;
    (*

    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).

    *)
  8. participantDetails : ParticipantDetails.t option;
  9. initialSystemMessage : Values_0.ChatMessage.t option;
  10. initialTemplatedSystemMessage : TemplatedMessageConfig.t option;
  11. relatedContactId : Values_0.ContactId.t option;
    (*

    The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

    *)
  12. supportedMessagingContentTypes : SupportedMessagingContentTypes.t option;
    (*

    The supported chat message content types. Supported types are: text/plain text/markdown application/json, application/vnd.amazonaws.connect.message.interactive 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]

    *)
  13. clientToken : Values_0.ClientToken.t option;
    (*

    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. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    *)
}
Sourceval context_ : string
Sourceval make : ?attributes:??? -> ?chatDurationInMinutes:??? -> ?participantDetails:??? -> ?initialSystemMessage:??? -> ?initialTemplatedSystemMessage:??? -> ?relatedContactId:??? -> ?supportedMessagingContentTypes:??? -> ?clientToken:??? -> sourceEndpoint:Values_0.Endpoint.t -> destinationEndpoint:Values_0.Endpoint.t -> instanceId:Values_0.InstanceId.t -> segmentAttributes:Values_0.SegmentAttributes.t -> contactFlowId:Values_0.ContactFlowId.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Integer of Values_0.ChatDurationInMinutes.t | `List of [> `String of SupportedMessagingContentType.t ] list | `Map of ([> `String of string ] * Awso.Botodata.value) list | `String of Values_0.InstanceId.t | `Structure of (string * [> `Enum of string | `String of string | `Structure of (string * [> `Map of ([> `String of string ] * [> `String of string ]) list | `String of Values_1.CustomerProfileAttributesSerialized.t ]) list ]) list ]) 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