Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendOutboundWebNotification

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.

Request Syntax


POST /instance/InstanceId/outbound-web-notification HTTP/1.1
Content-type: application/json

{
   "BrowserId": "string",
   "ClientToken": "string",
   "Content": { 
      "Attributes": { 
         "RecommenderConfig": { 
            "Context": { 
               "string" : "string" 
            },
            "DomainName": "string",
            "RecommenderName": "string"
         }
      },
      "Type": "string",
      "ViewArn": "string"
   },
   "Destination": { 
      "ProfileId": "string",
      "WidgetId": "string"
   },
   "ExpiresAt": number,
   "SessionId": "string",
   "Source": { 
      "SourceCampaign": { 
         "CampaignId": "string",
         "OutboundRequestId": "string"
      }
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

BrowserId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: Yes

ClientToken

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.

Type: String

Length Constraints: Maximum length of 500.

Required: No

Content

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

Type: WebNotificationContent object

Required: Yes

Destination

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

Type: WidgetDestination object

Required: Yes

ExpiresAt

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.

Type: Timestamp

Required: Yes

SessionId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: Yes

Source

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

Type: WebNotificationSource object

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429