Alexa For Business
Alexa for Business API (API Version 2017-11-09)

SendAnnouncement

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

Request Syntax

{ "ClientRequestToken": "string", "Content": { "AudioList": [ { "Locale": "string", "Location": "string" } ], "SsmlList": [ { "Locale": "string", "Value": "string" } ], "TextList": [ { "Locale": "string", "Value": "string" } ] }, "RoomFilters": [ { "Key": "string", "Values": [ "string" ] } ], "TimeToLiveInSeconds": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

The unique, user-specified identifier for the request that ensures idempotency.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 150.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

Content

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

Type: Content object

Required: Yes

RoomFilters

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

Type: Array of Filter objects

Array Members: Maximum number of 25 items.

Required: Yes

TimeToLiveInSeconds

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 3600.

Required: No

Response Syntax

{ "AnnouncementArn": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

AnnouncementArn

The identifier of the announcement.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Errors

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

AlreadyExistsException

The resource being created already exists.

HTTP Status Code: 400

LimitExceededException

You are performing an action that would put you beyond your account's limits.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: