Connect / Client / start_outbound_chat_contact

start_outbound_chat_contact

Connect.Client.start_outbound_chat_contact(**kwargs)

Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS 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 SMS contact created.

This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

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

• Set up SMS messaging

• Request an SMS-enabled phone number through AWS End User Messaging SMS

See also: AWS API Documentation

Request Syntax

response = client.start_outbound_chat_contact(
    SourceEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': 'string'
    },
    DestinationEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': 'string'
    },
    InstanceId='string',
    SegmentAttributes={
        'string': {
            'ValueString': 'string',
            'ValueMap': {
                'string': {'... recursive ...'}
            },
            'ValueInteger': 123
        }
    },
    Attributes={
        'string': 'string'
    },
    ContactFlowId='string',
    ChatDurationInMinutes=123,
    ParticipantDetails={
        'DisplayName': 'string'
    },
    InitialSystemMessage={
        'ContentType': 'string',
        'Content': 'string'
    },
    RelatedContactId='string',
    SupportedMessagingContentTypes=[
        'string',
    ],
    ClientToken='string'
)

Parameters:

• SourceEndpoint (dict) –

  [REQUIRED]

  Information about the endpoint.

  • Type (string) –

    Type of the endpoint.

  • Address (string) –

    Address of the endpoint.

• DestinationEndpoint (dict) –

  [REQUIRED]

  Information about the endpoint.

  • Type (string) –

    Type of the endpoint.

  • Address (string) –

    Address of the endpoint.

• InstanceId (string) –

  [REQUIRED]

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

• SegmentAttributes (dict) –

  [REQUIRED]

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

  • (string) –

    • (dict) –

      A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueString (string) –

        The value of a segment attribute.

      • ValueMap (dict) –

        The value of a segment attribute.

        • (string) –

          • (dict) –

            A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

      • ValueInteger (integer) –

        The value of a segment attribute.

• Attributes (dict) –

  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.

  • (string) –

    • (string) –

• ContactFlowId (string) –

  [REQUIRED]

  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

• ChatDurationInMinutes (integer) – 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 (dict) –

  The customer’s details.

  • DisplayName (string) – [REQUIRED]

    Display name of the participant.

• InitialSystemMessage (dict) –

  A chat message.

  • ContentType (string) – [REQUIRED]

    The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

  • Content (string) – [REQUIRED]

    The content of the chat message.

    • For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.

    • For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

    • For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.

• RelatedContactId (string) – The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

• SupportedMessagingContentTypes (list) –

  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]

  • (string) –

• ClientToken (string) –

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'ContactId': 'string'
}

Response Structure

• (dict) –

  • ContactId (string) –

    The identifier of this contact within the Amazon Connect instance.

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.ConflictException

• Connect.Client.exceptions.InternalServiceException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.LimitExceededException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.AccessDeniedException