Connect / Client / send_outbound_web_notification

send_outbound_web_notification

Connect.Client.send_outbound_web_notification(**kwargs)

Sends an outbound web notification to a customer’s web browser for outbound campaigns. For more information about outbound campaigns, see Set up Connect Customer outbound campaigns.

Note

Only the Connect Customer outbound campaigns service principal is allowed to assume a role in your account and call this API.

See also: AWS API Documentation

Request Syntax

response = client.send_outbound_web_notification(
    InstanceId='string',
    ClientToken='string',
    BrowserId='string',
    SessionId='string',
    ExpiresAt=datetime(2015, 1, 1),
    Source={
        'SourceCampaign': {
            'CampaignId': 'string',
            'OutboundRequestId': 'string'
        }
    },
    Destination={
        'WidgetId': 'string',
        'ProfileId': 'string'
    },
    Content={
        'Type': 'WIDGET_VIEW'|'WIDGET_ACTION',
        'ViewArn': 'string',
        'Attributes': {
            'RecommenderConfig': {
                'DomainName': 'string',
                'RecommenderName': 'string',
                'Context': {
                    'string': 'string'
                }
            }
        }
    }
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • ClientToken (string) –

    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.

    This field is autopopulated if not provided.

  • BrowserId (string) –

    [REQUIRED]

    A unique identifier for the customer’s web browser instance to which the notification is being sent.

  • SessionId (string) –

    [REQUIRED]

    A unique identifier for the customer’s web session to which the notification is being sent.

  • ExpiresAt (datetime) –

    [REQUIRED]

    The timestamp, in Unix epoch time format, at which the web notification expires. After this time, the notification is no longer delivered to the customer’s browser.

  • Source (dict) –

    [REQUIRED]

    The source of the web notification. A SourceCampaign object identifies the campaign and outbound request that triggered this notification.

    • SourceCampaign (dict) – [REQUIRED]

      Information about the campaign that triggered the web notification, including the campaign identifier and outbound request identifier.

      • CampaignId (string) –

        A unique identifier for a campaign.

      • OutboundRequestId (string) –

        A unique identifier for a each request part of same campaign.

  • Destination (dict) –

    [REQUIRED]

    The destination for the web notification, specifying the communication widget that delivers the notification and the customer profile of the recipient.

    • WidgetId (string) – [REQUIRED]

      The identifier of the communication widget that delivers the notification to the customer’s browser.

    • ProfileId (string) – [REQUIRED]

      The identifier of the customer profile associated with the browser session that should receive the notification.

  • Content (dict) –

    [REQUIRED]

    The content of the web notification, including the notification type, the view to render, and any optional attributes used to populate it.

    • Type (string) – [REQUIRED]

      The type of web notification to send.

    • ViewArn (string) –

      The Amazon Resource Name (ARN) of the view to render for the notification.

    • Attributes (dict) –

      Optional attributes used to populate the notification content, such as recommender configuration for personalized content.

      • RecommenderConfig (dict) –

        Configuration for the recommender used to generate personalized recommendations for the notification content.

        • DomainName (string) – [REQUIRED]

          The name of the Amazon Personalize domain that hosts the recommender.

        • RecommenderName (string) – [REQUIRED]

          The name of the recommender used to generate the recommendations.

        • Context (dict) –

          A map of contextual key-value pairs supplied to the recommender to influence the recommendations returned.

          • (string) –

            • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions