ResolveRoom - Alexa for Business

ResolveRoom

Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.

To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID.

Request Syntax

{ "SkillId": "string", "UserId": "string" }

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.

SkillId

The ARN of the skill that was requested. Required.

Type: String

Pattern: (^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})

Required: Yes

UserId

The ARN of the user. Required.

Type: String

Pattern: amzn1\.[A-Za-z0-9+-\/=.]{1,300}

Required: Yes

Response Syntax

{ "RoomArn": "string", "RoomName": "string", "RoomSkillParameters": [ { "ParameterKey": "string", "ParameterValue": "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.

RoomArn

The ARN of the room from which the skill request was invoked.

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}

RoomName

The name of the room from which the skill request was invoked.

Type: String

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

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]*

RoomSkillParameters

Response to get the room profile request. Required.

Type: Array of RoomSkillParameter objects

Errors

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

NotFoundException

The resource is not found.

HTTP Status Code: 400

See Also

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