Alexa.MeetingClientController Interface

Implement the Alexa.MeetingClientController interface in your Alexa skill so that users can join a meeting. For more information, see Build Skills for Conferencing Devices.

For the list of languages that the MeetingClientController interface supports, see List of Alexa Interfaces and Supported Languages.

• Utterances
• Discovery
• Directives
  • JoinMeeting directive
  • EndMeeting directive
  • JoinScheduledMeeting directive

Utterances

When you use the Alexa.MeetingClientController interface, the voice interaction model is already built for you. The following examples show some user utterances:

• English (All)

After the user says an utterance, Alexa sends a corresponding directive to your skill. If Alexa needs more information first, such as to identify the correct meeting to join, Alexa prompts the user.

Discovery

You describe endpoints that support Alexa.MeetingClientController using the standard discovery mechanism described in Alexa.Discovery.

For the full list of display categories, see display categories.

In addition to the usual discovery response fields, for the MeetingClientController entry in the capabilities array, include the following fields.

Discover response example

The following example shows a Discover.Response message for a device that supports the Alexa.MeetingClientController and Alexa.Calendar interfaces.

{
  "event": {
    "header": {
      "namespace": "Alexa.Discovery",
      "name": "Discover.Response",
      "payloadVersion": "3",
      "messageId": "<message id>"
    },
    "payload": {
      "endpoints":[
        {
          "endpointId": "<unique ID of the endpoint>",
          "manufacturerName": "<the manufacturer name of the endpoint>",
          "modelName": "<the model name of the endpoint>",
          "description": "<a description that is shown in the Alexa app>",
          "friendlyName": "<device name, displayed in the Alexa app>",
          "displayCategories": ["OTHER"],
          "cookie": {},
          "capabilities": [
            {
              "type": "AlexaInterface",
              "interface": "Alexa.MeetingClientController",
              "version": "1.0",
              "supportsScheduledMeeting": false
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa.Calendar",
              "version": "1.0"
            },
            {
              "type": "AlexaInterface",
              "interface": "Alexa",
              "version": "3"
            }
          ]
        }
      ]
    }
  }
}

Directives

JoinMeeting directive

Support the JoinMeeting directive so that users can join a meeting when they know the id of the meeting that they want to join. You must support the JoinMeeting directive.

The following example shows a customer utterance:

• English

JoinMeeting directive payload details

JoinMeeting directive example

The following example illustrates a JoinMeeting directive that Alexa sends to your skill.

{
  "directive": {
    "header": {
      "namespace": "Alexa.MeetingClientController",
      "name": "JoinMeeting",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerTokenWithPartition",
        "token": "<an OAuth2 bearer token>",
        "partition": "<partition, for example, room101>",
        "userId": "<user id>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {
      "meeting": {
        "provider": "<chime>",
        "protocol": "<sip>",
        "endpoint": "<54.19.29.39>",
        "id": "<1234>",
        "pin": "<5678>"
      }
    }
  }
}

JoinMeeting response event

If you handle a JoinMeeting directive successfully, respond with an Alexa.Response event.

JoinMeeting response event example

{
  "event": {
    "header": {
      "namespace": "Alexa ",
      "name": " Response",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "payload": {}
  }
}

JoinMeeting directive error handling

If you can't handle a JoinMeeting directive successfully, respond with an Alexa.ErrorResponse event.

EndMeeting directive

Support the EndMeeting directive so that users can end a meeting. You must support the EndMeeting directive. When Alexa sends the EndMeeting directive, you should end all active meetings.

The following example shows a customer utterance:

• English

EndMeeting directive example

The following example illustrates a EndMeeting directive that Alexa sends to your skill.

{
  "directive": {
    "header": {
      "namespace": "Alexa.MeetingClientController",
      "name": "EndMeeting",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerTokenWithPartition",
        "token": "<an OAuth2 bearer token>",
        "partition": "<partition, for example, room101>",
        "userId": "<user id>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {}
  }
}

EndMeeting response event

If you handle a EndMeeting directive successfully, respond with an Alexa.Response event.

EndMeeting response event example

{
  "event": {
    "header": {
      "namespace": "Alexa ",
      "name": " Response",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "payload": {}
  }
}

EndMeeting directive error handling

If you can't handle a EndMeeting directive successfully, respond with an Alexa.ErrorResponse event.

JoinScheduledMeeting directive

Support the JoinScheduledMeeting directive so that users can join a meeting without knowing id of the meeting that they want to join. Supporting the JoinScheduledMeeting directive is optional.

You should support the JoinScheduledMeeting directive if your skill has access to an organization's calendar, and you can access the identifiers of meetings on that calendar. If you support this directive, set supportsScheduledMeeting to true in your discovery response. To support the JoinScheduledMeeting directive, you must also implement the Alexa.Calendar interface.

The following example shows a customer utterance:

• English

JoinScheduledMeeting directive payload details

JoinScheduledMeeting directive example

The following example illustrates a JoinScheduledMeeting directive that Alexa sends to your skill.

{
  "directive": {
    "header": {
      "namespace": "Alexa.MeetingClientController",
      "name": "JoinScheduledMeeting",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "endpoint": {
      "scope": {
        "type": "BearerTokenWithPartition",
        "token": "<an OAuth2 bearer token>",
        "partition": "<partition, for example, room101>",
        "userId": "<user id>"
      },
      "endpointId": "<endpoint id>",
      "cookie": {}
    },
    "payload": {
      "calendarEventId": "<meeting ID>"
    }
  }
}

JoinScheduledMeeting response event

If you handle a JoinScheduledMeeting directive successfully, respond with an Alexa.Response event.

JoinScheduledMeeting response event example

{
  "event": {
    "header": {
      "namespace": "Alexa ",
      "name": " Response",
      "messageId": "<message id>",
      "correlationToken": "<an opaque correlation token>",
      "payloadVersion": "3"
    },
    "payload": {}
  }
}

JoinScheduledMeeting directive error handling

If you can't handle a JoinScheduledMeeting directive successfully, respond with an Alexa.ErrorResponse event.