イベントメッセンジャーAPIリファレンス

イベントメッセンジャーAPIリファレンス

イベントメッセンジャーAPIを使用すると、Alexaイベント受信のサブスクリプションを行うことができます。これらのイベントを使って、アラームの起動や操作の再試行といったアクションを実行することができます。たとえば、スキルタイムアウトイベントのアラームを作成して、スキルを稼動させているウェブサービスが正常に実行されているかどうかを確認できます。現在、サポートされているイベント配信チャネルはAmazon Simple Notification Service（SNS）のみです。

このAPIを使用するには、まずサブスクリプション設定を作成し、複数のサブスクリプションで使用できる配信チャネルを定義します。次に、サブスクリプション対象のイベントのタイプおよび使用するサブスクリプション設定を指定したサブスクリプションを作成します。

イベントメッセンジャーAPIの使い方の詳細については、Alexa Smart Properties in Senior Livingのイベントを受信するを参照してください。

APIエンドポイント

イベントメッセンジャーAPIのエンドポイントは、https://api.amazonalexa.comです。

認証

すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。

操作

イベントメッセンジャーAPIには、以下の操作が用意されています。

操作 HTTPメソッドとURI

サブスクリプション設定を作成する

POST /v1/eventMessenger/subscriptionConfigurations

IDを指定してサブスクリプション設定を取得する

GET /v1/eventMessenger/subscriptionConfigurations/{id}

サブスクリプション設定を取得する

GET /v1/eventMessenger/subscriptionConfigurations

サブスクリプション設定を削除する

DELETE /v1/eventMessenger/subscriptionConfigurations/{id}

サブスクリプションを作成する

POST /v1/eventMessenger/subscriptions

IDを指定してサブスクリプションを取得する

GET /v1/eventMessenger/subscriptions/{id}

サブスクリプションを取得する

GET /v1/eventMessenger/subscriptions

サブスクリプションを削除する

DELETE /v1/eventMessenger/subscriptions/{id}

サブスクリプション設定を作成する

サブスクリプション設定を作成し、複数のサブスクリプションで使用できる配信チャネルを定義します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプション設定を作成するには、/v1/eventMessenger/subscriptionConfigurationsリソースへのPOSTリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

POST /v1/eventMessenger/subscriptionConfigurations
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

リクエスト本文の例

クリップボードにコピーされました。

{
  "deliveryChannels": [{
    "type": "SNS",
    "id": "arn:aws:sns:us-east-1:0123456789:AlexaEvents"
  }]
}

リクエスト本文のパラメーター

パラメーター 説明 型 必須

deliveryChannels

配信メカニズム設定オブジェクトのリスト。

オブジェクトの配列

◯

deliveryChannels[*].type

配信チャネルのタイプ。有効な値： SNS。

文字列

◯

deliveryChannels[*].id

更新の必要なチャネルのID。有効な値： イベントのパブリッシュ先となるSNSトピックのAmazonリソースネーム（ARN）。

列挙型文字列

◯

応答

正常に完了すると、サブスクリプション設定IDがLocationヘッダーに指定されたHTTP 201 Createdが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
  "id": "amzn1.alexa.aem.subscription.configuration.123"
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

id

サブスクリプション設定の一意のID。UUID形式です。

文字列

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

201 Created

サブスクリプション設定が正常に作成されました。

400 Bad Request

リクエストが無効です。必須フィールドがない、値が正しくない、正しいJSON形式ではないことが原因です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

IDを指定してサブスクリプション設定を取得する

設定IDを指定してサブスクリプション設定を取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

設定IDを使用してサブスクリプション設定を取得するには、/v1/eventMessenger/subscriptionConfigurations/{id}リソースへのGETリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptionConfigurations/amzn1.alexa.aem.subscription.configuration.123
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

id

クエリ

取得するサブスクリプション設定の一意のID。サブスクリプション設定を作成するの操作で返されたIDです。

文字列

◯

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
    "id": "amzn1.alexa.aem.subscription.configuration.123",
    "deliveryChannels": [{
        "type": "SNS",
        "id": "arn.aws.sns::12345:us-east1:abc"
    }]
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

id

サブスクリプション設定の一意のID。UUID形式です。

文字列

deliveryChannels

配信メカニズム設定オブジェクトのリスト。

オブジェクトの配列

deliveryChannels[*].type

配信チャネルのタイプ。有効な値： SNS。

文字列

deliveryChannels[*].id

更新の必要なチャネルのID。有効な値： イベントのパブリッシュ先となるSNSトピックのAmazonリソースネーム（ARN）。

列挙型文字列

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

200 OK

サブスクリプション設定が正常に取得されました。

400 Bad Request

サブスクリプション設定IDが無効です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

404 Not Found

サブスクリプション設定が存在しません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

サブスクリプション設定を取得する

サブスクリプション設定を取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプション設定を取得するには、/v1/eventMessenger/subscriptionConfigurationsリソースへのGETリクエストを行います。

リクエストヘッダーの例

所有者を指定してサブスクリプション設定をリクエストする

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptionConfigurations?owner=~caller
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

ページ分割を使用するリクエスト

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptionConfigurations?owner=~caller&nextToken=6666611111&maxResults=20
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

owner

クエリ

呼び出し元が所有するものにサブスクリプション設定を限定するパラメーター。
現在サポートされている値は"~caller"のみで、これはベアラートークンに含まれる情報を表します。

文字列

◯

nextToken

クエリ

ページ分割された結果から特定のページを取得するためのトークン。このトークンがない場合、応答には結果の先頭ページが含められます。

文字列

✕

maxResults

クエリ

応答本文で返される結果の最大数。100以下の正の値を指定してください。デフォルト値は20です。

数値

✕

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
    "results": [{
          "id": "amzn1.alexa.aem.subscription.configuration.123",
          "deliveryChannels": [{
             "type": "SNS",
             "id": "arn.aws.sns::12345:us-east1:abc"
          }]
        },
        {
          "id": "amzn1.alexa.aem.subscription.configuration.456",
          "deliveryChannels": [{
             "type": "SNS",
             "identifier": "arn.aws.sns::12345:us-east1:abc"
          }]
        }
    ],
    "paginationContext": {
       "nextToken": null
    }
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

results

サブスクリプション設定オブジェクトのリスト。

オブジェクトの配列

results[*].id

サブスクリプション設定の一意のID。UUID形式です。

文字列

results[*].deliveryChannels

配信メカニズム設定オブジェクトのリスト。

オブジェクトの配列

results[*].deliveryChannels[*].deliveryChannel.type

配信チャネルのタイプ。有効な値： SNS。

文字列

results[*].deliveryChannels[*].deliveryChannel.id

更新の必要なチャネルのID。有効な値： イベントのパブリッシュ先となるSNSトピックのAmazonリソースネーム（ARN）。

列挙型文字列

paginationContext

ページ分割の詳細。

オブジェクト

paginationContext.nextToken

ページ分割された結果から特定のページを取得するためのトークン。

文字列

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

200 OK

サブスクリプション設定が正常に取得されました。

400 Bad Request

リクエストが無効です。必須フィールドがない、値が正しくない、正しいJSON形式ではないことが原因です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

サブスクリプション設定を削除する

サブスクリプション設定を削除します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプション設定を削除するには、/v1/eventMessenger/subscriptionConfigurations/{id}リソースへのDELETEリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

DELETE /v1/eventMessenger/subscriptionConfigurations/amzn1.alexa.aem.subscription.configuration.123
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

id

クエリ

削除するサブスクリプション設定の一意のID。サブスクリプション設定を作成するの操作で返されたIDです。

文字列

◯

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 204 Contentが返されます。

応答本文の例

正常に完了した場合、応答の本文はありません。

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

正常に完了した場合、応答の本文はありません。

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

204 No Content

リクエストは正常に処理されました。

400 Bad Request

サブスクリプション設定IDが無効です。

400 Invalid Config ID

サブスクリプション設定を削除できません。1つ以上のサブスクリプションが関連付けられています。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

404 Not Found

サブスクリプション設定が存在しません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

サブスクリプションを作成する

サブスクリプション対象のイベントのタイプおよび使用するサブスクリプション設定を指定したサブスクリプションを作成します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプションを作成するには、/v1/eventMessenger/subscriptionsリソースへのPOSTリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

POST /v1/eventMessenger/subscriptions
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

リクエスト本文の例

クリップボードにコピーされました。

{
    "subscriptionConfigurationId": "amzn1.alexa.aem.subscription.configuration.123",
    "eventType": {
        "namespace": "Alexa.Automation.Execution",
        "name": "Completion"
    },
    "entities": {
        "unit": {
            "type": "Unit",
            "id": "amzn1.alexa.unit.did.{id}"
        }
    }
}

リクエスト本文のパラメーター

パラメーター 説明 型 必須

subscriptionConfigurationId

サブスクリプション設定を作成するの手順で作成されたサブスクリプション設定の設定ID。

文字列

◯

eventType

イベントの詳細が含まれたオブジェクト。

オブジェクト

◯

eventType.namespace

イベントが属するカテゴリー。オートメーション関連のイベントはすべて同じ名前空間を使用します。例： Alexa.Automation.Execution

文字列

◯

eventType.name

名前空間内のイベント名。例： Completion

文字列

◯

entities

イベント生成の基になる、またはイベントと直接関連のある、リソースまたはエクスペリエンスを定義するエンティティ。エンティティからはイベントに関する追加のコンテキストとメタデータが得られ、ルーティングやアクセス制御に使用できます。

サブスクリプションを行えるのは、自分が作成または所有するエンティティのイベントの受信のみです。たとえば、ユニットについてサブスクリプションを行えるのは、自分が作成するユニットのイベントについてのみです。スキルについてサブスクリプションを行えるのは、自分が所有するスキルのイベントの受信のみです。

エンティティのオブジェクト。詳細については、ユニットエンティティとスキルエンティティを参照してください。

✕

ユニットエンティティ

ユニットエンティティは以下のイベントに必要です。

  • Alexa.Automation.Execution.Completion
  • Alexa.Skill.Interaction.Failure
  • Alexa.Enterprise.Subscription.Activation
パラメーター 説明 型 必須

unit

ユニットの詳細を表すオブジェクト。

オブジェクト

✕

unit.type

ユニットのエンティティタイプ。有効な値： Unit

列挙型文字列

✕

unit.id

ユニットID。

文字列

✕

unit.parent

親ユニット。親IDを指定します。

オブジェクト

✕

スキルエンティティ

スキルエンティティは以下のイベントに必要です。

  • Alexa.Skill.Interaction.Failure
パラメーター 説明 型 必須

skill

スキルの詳細を表すオブジェクト。

オブジェクト

✕

skill.type

スキルのエンティティタイプ。有効な値： Skill

列挙型文字列

✕

skill.id

スキルID。

文字列

✕

応答

正常に完了すると、サブスクリプションIDがLocationヘッダーに指定されたHTTP 201 Createdが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
  "id": "amzn1.alexa.aem.subscription.123"
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

id

一意のサブスクリプションID。UUID形式です。

文字列

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

201 Created

サブスクリプションが正常に作成されました。

400 Bad Request

サブスクリプション設定IDが無効です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。新しいスキルのスキルエラーイベントを受信するサブスクリプションを行っている場合、イベントにタグ付けされたスキルがないことがあり、403エラーが生成されます。この場合は、ソリューションアーキテクトに連絡して、スキルへの適切なタグ付けを依頼してください。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

IDを指定してサブスクリプションを取得する

サブスクリプションIDを指定してサブスクリプションを取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプションを取得するには、/v1/eventMessenger/subscriptions/{id}リソースへのGETリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptions/amzn1.alexa.aem.subscription.123
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

id

クエリ

取得するサブスクリプションの一意のID。

文字列

◯

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
    "id": "amzn1.alexa.aem.subscription.123",
    "subscriptionConfigurationId": "amzn1.alexa.aem.subscription.configuration.123",
    "eventType": {
        "namespace": "Alexa.Automation.Execution",
        "name": "Completion"
    },
    "entities": {
        "unit": {
            "type": "Unit",
            "id": "amzn1.alexa.unit.did.{id}"
        }
    }
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

id

一意のサブスクリプションID。UUID形式です。

文字列

subscriptionConfigurationId

サブスクリプション設定を作成するの手順で作成されたサブスクリプション設定の設定ID。

文字列

eventType

イベントの詳細が含まれたオブジェクト。

オブジェクト

eventType.namespace

イベントが属するカテゴリー。オートメーション関連のイベントはすべて同じ名前空間を使用します。例： Alexa.Automation.Execution

文字列

eventType.name

名前空間内のイベント名。例： Completion

文字列

entities

イベント生成の基になる、またはイベントと直接関連のある、リソースまたはエクスペリエンスを定義するエンティティ。エンティティからはイベントに関する追加のコンテキストとメタデータが得られ、ルーティングやアクセス制御に使用できます。

エンティティのオブジェクト。詳細については、ユニットエンティティとスキルエンティティを参照してください。

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

200 OK

サブスクリプションが正常に取得されました。

400 Bad Request

サブスクリプションIDが無効です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

404 Not Found

サブスクリプションが存在しません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

サブスクリプションを取得する

サブスクリプションを取得します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプションを取得するには、/v1/eventMessenger/subscriptionsリソースへのGETリクエストを行います。

リクエストヘッダーの例

所有者を指定してサブスクリプションをリクエストする

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptions?owner=~caller
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

entities.unit.idとentities.unit.typeを指定してサブスクリプションをリクエストする

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptions?owner=~caller&entities.unit.id=amzn1.alexa.unit.did.123&entities.unit.type=Unit
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

ページ分割を使用するリクエスト

クリップボードにコピーされました。

GET /v1/eventMessenger/subscriptions?owner=~caller&nextToken=6666611111&maxResults=20
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

owner

クエリ

呼び出し元が所有するものにサブスクリプションを限定するパラメーター。
現在サポートされている値は"~caller"のみで、これはベアラートークンに含まれる情報を表します。

文字列

◯

entities.unit.id

クエリ

特定のunitIdに関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、entities.unit.typeパラメーターも含める必要があります。

owner、（entities.unit.id && entities.unit.type）、（entities.unit.parent.id && entities.unit.parent.type）のいずれかが必須です。

文字列

✕：説明を参照してください。

entities.unit.type

クエリ

特定のunitTypeに関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、entities.unit.idパラメーターも含める必要があります。

owner、（entities.unit.id && entities.unit.type）、（entities.unit.parent.id && entities.unit.parent.type）のいずれかが必須です。

文字列

✕：説明を参照してください。

entities.unit.parent.id

クエリ

特定の親unitIdに関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、entities.parent.typeパラメーターも含める必要があります。

owner、（entities.unit.id && entities.unit.type）、（entities.unit.parent.id && entities.unit.parent.type）のいずれかが必須です。

文字列

✕：説明を参照してください。

entities.unit.parent.type

クエリ

特定の親unitTypeに関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、entities.parent.idパラメーターも含める必要があります。

owner、（entities.unit.id && entities.unit.type）、（entities.unit.parent.id && entities.unit.parent.type）のいずれかが必須です。

文字列

✕：説明を参照してください。

eventType.namespace

クエリ

特定の親eventType名前空間に関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、eventType.nameパラメーターも含める必要があります。

文字列

✕

eventType.name

クエリ

特定の親eventType名に関連付けられているものにサブスクリプションを限定するパラメーター。このパラメーターを含める場合は、eventType.namespaceパラメーターも含める必要があります。

文字列

✕

nextToken

クエリ

ページ分割された結果から特定のページを取得するためのトークン。このトークンがない場合、応答には結果の先頭ページが含められます。

文字列

✕

maxResults

クエリ

応答本文で返される結果の最大数。100以下の正の値を指定してください。デフォルト値は20です。

数値

✕

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 200 OKが返されます。

応答本文の例

以下は、成功した応答の本文の例です。

{
   "results": [{
       "id": "amzn1.alexa.aem.subscription.123",
       "subscriptionConfigurationId": "amzn1.alexa.aem.subscription.configuration.123",
       "eventType": {
           "namespace": "Alexa.Automation.Execution",
           "name": "Completion"
       },
       "entities": {
           "unit": {
               "type": "Unit",
               "id": "amzn1.alexa.unit.did.{id}"
           }
        }
     }
   ],
   "paginationContext": {
       "nextToken": null
   }
}

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

パラメーター 説明 型

paginationContext

ページ分割の詳細。

オブジェクト

paginationContext.nextToken

ページ分割された結果から特定のページを取得するためのトークン。

文字列

results

サブスクリプションオブジェクトのリスト。

オブジェクトの配列

results.id

一意のサブスクリプションID。UUID形式です。

文字列

results.subscriptionConfigurationId

サブスクリプション設定を作成するの手順で作成されたサブスクリプション設定の設定ID。

文字列

results.eventType

イベントの詳細が含まれたオブジェクト。

オブジェクト

results.eventType.namespace

イベントが属するカテゴリー。オートメーション関連のイベントはすべて同じ名前空間を使用します。例： Alexa.Automation.Execution

文字列

results.eventType.name

名前空間内のイベント名。例： Completion

文字列

results.entities

イベント生成の基になる、またはイベントと直接関連のある、リソースまたはエクスペリエンスを定義するエンティティ。エンティティからはイベントに関する追加のコンテキストとメタデータが得られ、ルーティングやアクセス制御に使用できます。

エンティティのオブジェクト。詳細については、ユニットエンティティとスキルエンティティを参照してください。

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

200 OK

サブスクリプションが正常に取得されました。

400 Bad Request

サブスクリプションIDが無効です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

404 Not Found

サブスクリプションが存在しません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

サブスクリプションを削除する

サブスクリプションを削除します。

この操作は以下の国で使用できます。

Healthcare Hospitality Residential Senior Living Core

米国

なし

なし

米国

米国

リクエスト

サブスクリプションを削除するには、/v1/eventMessenger/subscriptions/{id}リソースへのDELETEリクエストを行います。

リクエストヘッダーの例

クリップボードにコピーされました。

DELETE /v1/eventMessenger/subscriptions/amzn1.alexa.aem.subscription.123
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

リクエストのヘッダーとパスのパラメーター

パラメーター 位置 説明 型 必須

access token

ヘッダー

LWAアクセストークン。

文字列

◯

id

クエリ

削除するサブスクリプションの一意のID。

文字列

◯

リクエスト本文の例

リクエストの本文はありません。

リクエスト本文のパラメーター

リクエストの本文はありません。

応答

正常に完了すると、HTTP 204 Contentが返されます。

応答本文の例

正常に完了した場合、応答の本文はありません。

以下は、エラー応答の本文の例です。

{
    "type": "ERROR_TYPE",
    "message": "ERROR_MESSAGE"
}

成功した応答本文のパラメーター

正常に完了した場合、応答の本文はありません。

エラー応答本文のパラメーター

パラメーター 説明 型

type

エラーのタイプ。

文字列

message

エラーの説明。

文字列

HTTPステータスコード

ステータス 説明

204 No Content

リクエストは正常に処理されました。

400 Bad Request

サブスクリプションIDが無効です。

401 Unauthorized

認可トークンが無効または期限切れか、リソースに対するアクセス権限が認可トークンにありません。

403 Forbidden

リクエストを完了できませんでした。この操作を実行する権限がクライアントにありません。

404 Not Found

サブスクリプションが存在しません。

429 Too Many Requests

リクエストが制限されました。1秒後に再試行したら、エクスポネンシャルバックオフを行い、待機間隔が256秒になったら、以降は429以外の応答を受信するまで256秒ごとに再試行することをお勧めします。

500 Internal Server Error

サーバー側のエラーが発生しました。

503 Unavailable

サービスを一時的に使用できず、リクエストを受け付けることができませんでした。

最終更新日: 2023 年 03 月 06 日