InteractionModel 1.0


After implementing support for the InteractionModel interface, an end user can designate that the device can respond to a Routine by selecting it as the device that "Alexa will respond from" using the Amazon Alexa app. This also allows a user to trigger a Routine from one device and target a different device to respond.

Make sure to familiarize yourself with the AVS interaction model voice request lifecycle.

Capability Assertion

InteractionModel 1.0 may be implemented by the device on its own behalf, but not on behalf of any connected endpoints.

New AVS integrations must assert support through Alexa.Discovery, but Alexa will continue to support existing integrations using the Capabilities API.

Sample Object

{
    "type": "AlexaInterface",
    "interface": "InteractionModel",
    "version": "1.0"
}

NewDialogRequest Directive

When an interaction is initiated by Alexa, a NewDialogRequest directive with a unique dialogRequestId is sent to a client. The dialogRequestId in the payload of a NewDialogRequest directive must be set to active and runs immediately. Directives with a dialogRequestId in the header that match the dialogRequestId from NewDialogRequest directives must be processed in sequence. For more information about interactions, see the Alexa Voice Service Interaction Model.

Sample Message

{
  "directive": {
    "header": {
      "namespace": "InteractionModel",
      "name": "NewDialogRequest",
      "messageId": "{{STRING}}"
    },
    "payload": {
      "dialogRequestId": "{{STRING}}"
    }
  }
}

Payload Parameters

Parameter Description Type
dialogRequestId A dialogRequestId provided by Alexa that replaces the current dialogRequestId set on your client. Subsequent directives from Alexa will use this dialogRequestId and conform the rules defined in the Alexa Voice Service Interaction Model. string

Was this page helpful?

Last updated: Nov 27, 2023