Skip to content

Sends an outbound web notification to a customer's web browser for outbound campaigns

Description

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.

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

Usage

connect_send_outbound_web_notification(InstanceId, ClientToken,
  BrowserId, SessionId, ExpiresAt, Source, Destination, Content)

Arguments

  • InstanceId

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

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

  • BrowserId

[required] A unique identifier for the customer's web browser instance to which the notification is being sent.

  • SessionId

[required] A unique identifier for the customer's web session to which the notification is being sent.

  • ExpiresAt

[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

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

  • Destination

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

  • Content

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

Value

An empty list.

Request syntax

svc$send_outbound_web_notification(
  InstanceId = "string",
  ClientToken = "string",
  BrowserId = "string",
  SessionId = "string",
  ExpiresAt = as.POSIXct(
    "2015-01-01"
  ),
  Source = list(
    SourceCampaign = list(
      CampaignId = "string",
      OutboundRequestId = "string"
    )
  ),
  Destination = list(
    WidgetId = "string",
    ProfileId = "string"
  ),
  Content = list(
    Type = "WIDGET_VIEW"|"WIDGET_ACTION",
    ViewArn = "string",
    Attributes = list(
      RecommenderConfig = list(
        DomainName = "string",
        RecommenderName = "string",
        Context = list(
          "string"
        )
      )
    )
  )
)