定型アクションのトリガーインスタンスREST APIリファレンス
定型アクションのトリガーインスタンスAPIは、Alexa定型アクションのカスタムトリガーをディスパッチします。
APIエンドポイント
開発エンドポイント
スキルの開発中は、以下のエンドポイントを使用してトリガーインスタンスの送信をテストできます。
- 北米：
https://api.amazonalexa.com/v1/routines/triggerInstances/stages/development
本番エンドポイント
Amazonがスキルを認定したら、以下の本番エンドポイントを使用できます。
- 北米：
https://api.amazonalexa.com/v1/routines/triggerInstances
認証
すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with Amazon（LWA）から取得したアクセストークンが入ります。スコープをscope=alexa::routines:triggerinstances:writeに設定してください。
操作
定型アクションのカスタムトリガーAPIには、以下の操作が用意されています。
| 操作 | HTTPメソッドとURI |
|---|---|
|
|
トリガーインスタンスをディスパッチする
トリガー情報とターゲット受信者を指定して、トリガーインスタンスを送信します。
リクエスト
トリガーインスタンスをディスパッチするには、routines/triggerInstancesに対してPOSTリクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v1/routines/triggerInstances
Host: api.amazonalexa.com
Content-type: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
| パラメーター | 指定場所 | 説明 | 型 | 必須 |
|---|---|---|---|---|
|
|
ヘッダー |
LWAトークン。詳細については、SMAPIで使用するアクセストークンの取得方法を参照してください。 |
文字列 |
◯ |
リクエスト本文の例
リクエスト本文のプロパティ
| プロパティ | 説明 | 型 | 必須 |
|---|---|---|---|
|
|
特定のリクエストの一意のID。1～100文字で指定できます。 |
文字列 |
◯ |
|
|
トリガーインスタンスの受信者が単一のAlexaアカウント（UNICAST）か複数のAlexaアカウント（MULTICAST）かを識別します。指定できる値は、 |
文字列 |
◯ |
|
|
トリガーインスタンスの情報。 |
オブジェクト |
◯ |
|
|
トリガー登録ペイロードで定義されているトリガー名。1～50文字で指定できます。 |
文字列 |
◯ |
|
|
トリガーを設定するためにサービスプロバイダーインターフェース（SPI）リクエストで送信されたトリガーパラメーターオブジェクトと同じパラメーター。詳細については、定型アクショントリガーのサービスプロバイダーインターフェースを参照してください。 |
オブジェクト |
◯ |
|
|
トリガーを設定した受信者の情報。 |
オブジェクトの配列 |
◯（ |
|
|
イベント受信者の値のタイプ。本リリースで指定可能な値は |
文字列 |
◯（ |
|
|
イベントの受信者を表すオブジェクト。タイプが |
オブジェクト |
◯（ |
|
|
受信者の一意なID。形式は |
文字列 |
◯（ |
|
|
このパラメーターは、ユーザーがAlexaスキルにリンクされたアカウントを保有している場合に使用し、アクセストークンなどのユーザーのアカウントリンク情報を指定します。 |
オブジェクト |
× |
|
|
提供されたトークンのタイプ。本リリースでサポートされている値は |
文字列 |
× |
|
|
ユーザーのアカウント情報にアクセスするためのトークンの値。 |
文字列 |
× |
応答
正常に完了すると、HTTP 202 OKが返され、応答本文にrequestIdが表示されます。エラーの場合は、適切なHTTPステータスコードが返され、応答本文にエラーコードと人が読める形式のメッセージが表示されます。
成功した場合の応答本文の例
応答本文のプロパティ
| プロパティ | 説明 | 型 |
|---|---|---|
|
|
トリガーインスタンスリクエストと同じ |
文字列 |
失敗した場合の応答本文の例
応答本文のプロパティ
| プロパティ | 説明 | 型 |
|---|---|---|
|
|
トリガーインスタンスリクエストで送信された |
文字列 |
|
|
Alexaサービスで発生したエラーの状態を一意に識別する文字列。詳細については、HTTPステータスコードを参照してください。 |
文字列 |
|
|
エラー状態の一般的な説明を記載した英文メッセージ。 |
文字列 |
HTTPステータスコード
| HTTPステータスコード | 型 | 説明 |
|---|---|---|
|
|
|
操作は成功しました。 |
|
|
|
リクエストペイロードに無効なパラメーターがあります。 |
|
|
|
アクセストークンが無効です。 |
|
|
|
リクエスターにトリガータイプにアクセスする権限がありません。 |
|
|
|
リクエストリソースが見つかりません。 |
|
|
|
サーバーが大量のリクエストを受信しました。 |
|
|
|
リクエストの処理中に内部エラーが発生しました。 |
|
|
|
サーバーはリクエストを受け付けることができません。 |
関連トピック
最終更新日: 2025 年 11 月 10 日