Skip to content

Initiates a new outbound SMS or WhatsApp contact to a customer

Description

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 start_outbound_chat_contact Flow Action.

For more information about using SMS or WhatsApp in Connect Customer, see the following topics in the Connect Customer Administrator Guide:

Usage

connect_start_outbound_chat_contact(SourceEndpoint, DestinationEndpoint,
  InstanceId, SegmentAttributes, Attributes, ContactFlowId,
  ChatDurationInMinutes, ParticipantDetails, InitialSystemMessage,
  InitialTemplatedSystemMessage, RelatedContactId,
  SupportedMessagingContentTypes, ClientToken)

Arguments

  • SourceEndpoint

    [required] Information about the endpoint.

  • DestinationEndpoint

    [required] Information about the endpoint.

  • InstanceId

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

  • SegmentAttributes

    [required] A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Connect Customer 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.

  • Attributes

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

  • ContactFlowId

    [required] The identifier of the flow for the call. To see the ContactFlowId in the Connect Customer 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

  • ChatDurationInMinutes

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

  • ParticipantDetails

    The details of the participant, including their display name.

  • InitialSystemMessage

    A chat message.

  • InitialTemplatedSystemMessage

    Information about template message configuration.

  • RelatedContactId

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

  • SupportedMessagingContentTypes

    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]

  • ClientToken

    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.

Value

A list with the following syntax:

list(
  ContactId = "string"
)

Request syntax

svc$start_outbound_chat_contact(
  SourceEndpoint = list(
    Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
    Address = "string"
  ),
  DestinationEndpoint = list(
    Type = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
    Address = "string"
  ),
  InstanceId = "string",
  SegmentAttributes = list(
    list(
      ValueString = "string",
      ValueMap = list(
        list()
      ),
      ValueInteger = 123,
      ValueList = list(
        list()
      ),
      ValueArn = "string"
    )
  ),
  Attributes = list(
    "string"
  ),
  ContactFlowId = "string",
  ChatDurationInMinutes = 123,
  ParticipantDetails = list(
    DisplayName = "string"
  ),
  InitialSystemMessage = list(
    ContentType = "string",
    Content = "string"
  ),
  InitialTemplatedSystemMessage = list(
    KnowledgeBaseId = "string",
    MessageTemplateId = "string",
    TemplateAttributes = list(
      CustomAttributes = list(
        "string"
      ),
      CustomerProfileAttributes = "string"
    )
  ),
  RelatedContactId = "string",
  SupportedMessagingContentTypes = list(
    "string"
  ),
  ClientToken = "string"
)