タイマーREST APIリファレンス

タイマーREST APIリファレンス

タイマーREST APIを使用して、スキルでタイマーを作成、一時停止、再開、キャンセルできます。タイマーの設定時間が経過すると、Alexaはチャイム音を鳴らしたり、アナウンスを提供したり、タスクを起動したりできます。

タイマーの詳細については、Alexaタイマーの概要を参照してください。

APIエンドポイント

Alexaからのリクエストのcontext.System.apiEndpoint値に基づいて、次のいずれかのエンドポイントを使用します。

  • 北米:https://api.amazonalexa.com
  • ヨーロッパ:https://api.eu.amazonalexa.com
  • 極東:https://api.fe.amazon.com

認証

スキルセッションからのAPIリクエストの場合は、Alexaからのリクエスト(LaunchRequestIntentRequestなど)によって取得したcontext.System.apiAccessTokenを値に設定した認可ヘッダーを含めます。タイマーは、スキルセッションからのみ作成、一時停止、再開できます。

ウェブサイトまたはアプリからのセッション外のAPIリクエストの場合は、認可ヘッダーにLogin with Amazon(LWA)のアクセストークンを含めます。アクセストークンを取得する方法の詳細については、スキルにメッセージを送信するためのアクセス権限をリクエストするを参照してください。

オペレーション

タイマーAPIには、以下のオペレーションが含まれています。

オペレーション HTTPメソッドとURI

タイマーを作成する

POST /v1/alerts/timers

すべてのタイマーをキャンセルする

DELETE /v1/alerts/timers

タイマーをキャンセルする

DELETE /v1/alerts/timers/{id}

タイマーを取得する

GET /v1/alerts/timers/{id}

タイマーの一覧を取得する

GET /v1/alerts/timers

タイマーを一時停止する

POST /v1/alerts/timers/{id}/pause

タイマーを再開する

POST /v1/alerts/timers/{id}/resume

タイマーを作成する

新しいタイマーを作成して設定します。タイマーの設定時間と、設定時間が経過したときの動作を指定します。タイマーの設定時間が経過した場合、Alexaはチャイム音を鳴らしたり、アナウンスを提供したり、タスクを起動したりできます。

リクエスト

タイマーを作成するには、timersリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

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

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

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

access token

ヘッダー

ユーザーのアクセストークンです。
apiAccessTokenに設定します。

文字列

リクエスト本文の通知の例

リクエスト本文のアナウンスの例

リクエスト本文のタスク起動の例

リクエスト本文のプロパティ

プロパティ 説明 必須

duration

タイマーを実行する時間です。
たとえば、durationが90分の場合、タイマーの作成時刻から90分後にタイマーが作動します。ISO 8601の期間形式(PT*H*H*M*M*SS*S)で定義されます。
タイマーの最大設定時間は、 2時間です。

文字列

timerLabel

タイマーの名前です。ユーザーはこの名前でタイマーを参照できます。
有効な値は、 最大256文字です。

文字列

creationBehavior

タイマー作成時の動作を定義します。

オブジェクト

creationBehavior.displayExperience

画面付きAlexa搭載デバイスでのタイマーの動作を指定します。

オブジェクト

creationBehavior.displayExperience.visibility

画面付きAlexa搭載デバイスでのタイマーの表示/非表示を指定します。
有効な値は、 VISIBLEHIDDENです。

文字列

triggeringBehavior

タイマーの設定時間が経過したときのAlexaの動作を定義します。

オブジェクト

triggeringBehavior.operation

タイマーの設定時間が経過したときに実行するオペレーションを定義します。

Operationオブジェクト

triggeringBehavior.notificationConfig

タイマーの設定時間が経過したときに通知を再生するかどうかを定義します。

オブジェクト

triggeringBehavior.notificationConfig.playAudible

タイマーの設定時間経過が可聴であるかどうかを示します。
type = NOTIFY_ONLYの場合はtrueに設定する必要があります。trueに設定すると、Alexaはユーザーが「アレクサ、止めて」と言ってタイマーを解除するまで通知を再生します。

ブール値

応答

正常に完了すると、HTTP 200 OKと共に、タイマーの詳細が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。許可されている最大件数を超えてタイマーを作成しようとすると、Alexaはcode = MAX_TIMERS_EXCEEDEDHTTP 403 Forbiddenを返します。

応答本文の例

以下は、応答の例です。

{
    "id": "timer.id",
    "status": "PAUSED",
    "duration": "PT10M",
    "timerLabel": "エクササイズ",
    "triggerTime": "2019-09-12T19:10:00.083Z",
    "createdTime": "2019-09-12T19:00:00.083Z",
    "updatedTime": "2019-09-12T19:04:35.083Z",
    "remainingTimeWhenPaused": "PT5M25S"
}

応答本文のプロパティ

プロパティ 説明

id

タイマーを一意に識別します。

文字列

status

タイマーの状態です。
有効な値は、 ONOFFPAUSEDです。

  • ON - タイマーはアクティブで、triggerTimeに鳴動するか、triggerTimeが過ぎている場合は現在鳴動中です。
  • OFF - タイマーの設定時間が経過したか、ユーザーがタイマーをキャンセルしました。
  • PAUSED - タイマーはオンになっていましたが、現在一時停止されています。ユーザーはこのタイマーを再開できます。

文字列

duration

タイマーの継続時間です。
ISO 8601の期間形式(PT*H*H*M*M*SS*S)で定義されます。

文字列

timerLabel

(任意)タイマーの名前です。ユーザーはこの名前でタイマーを参照できます。
有効な値は、 最大256文字です。

文字列

triggerTime

タイマーの設定時間が経過し、ユーザーに通知する時間です。
ISO 8601の形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

createdTime

タイマーが作成された時刻です。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

updatedTime

タイマーが最後に一時停止、再開、停止された時刻です。存在しない場合は、createdTimeに設定されます。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

remainingTimeWhenPaused

(任意)タイマーが一時停止された場合の残り時間を指定します。
ISO 8601のキュレーション形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

HTTPステータスコード

ステータス 説明

200 OK

応答本文にタイマーの情報が含まれています。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

すべてのタイマーをキャンセルする

任意のAlexa搭載デバイスを使用してこのスキルでユーザー用に作成されたすべてのタイマーをキャンセル・削除します。

リクエスト

タイマーをキャンセルするには、timersリソースに対してDELETEリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

DELETE /v1/alerts/timers
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

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

access token

ヘッダー

ユーザーのアクセストークンです。
セッション内のリクエストの場合は、apiAccessTokenに設定します。
セッション外のリクエストの場合は、LWAトークンに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

200 OK

このスキルでユーザー用に作成されたすべてのタイマーが正常にキャンセルされました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

タイマーをキャンセルする

指定のタイマーをキャンセル・削除します。

リクエスト

タイマーをキャンセルするには、timersリソースに対してDELETEリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

DELETE /v1/alerts/timers/{id}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

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

id

パス

タイマーIDです。

文字列

access token

ヘッダー

ユーザーのアクセストークンです。
セッション内のリクエストの場合は、apiAccessTokenに設定します。
セッション外のリクエストの場合は、LWAトークンに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

200 OK

指定されたタイマーが正常にキャンセルされました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

タイマーを取得する

このスキルで作成された指定のタイマーを取得します。

リクエスト

タイマーを取得するには、timersリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v1/alerts/timers/{id}
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

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

id

パス

タイマーIDです。

文字列

access token

ヘッダー

ユーザーのアクセストークンです。
セッション内のリクエストの場合は、apiAccessTokenに設定します。
セッション外のリクエストの場合は、LWAトークンに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKと共に、タイマーの詳細が返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

プロパティ 説明

id

タイマーを一意に識別します。

文字列

status

タイマーの状態です。
有効な値は、 ONOFFPAUSEDです。

  • ON - タイマーはアクティブで、triggerTimeに鳴動するか、triggerTimeが過ぎている場合は現在鳴動中です。
  • OFF - タイマーの設定時間が経過したか、ユーザーがタイマーをキャンセルしました。
  • PAUSED - タイマーはオンになっていましたが、現在一時停止されています。ユーザーはこのタイマーを再開できます。

文字列

duration

タイマーの継続時間です。
ISO 8601の期間形式(PT*H*H*M*M*SS*S)で定義されます。

文字列

timerLabel

(任意)タイマーの名前です。ユーザーはこの名前でタイマーを参照できます。
有効な値は、 最大256文字です。

文字列

triggerTime

タイマーの設定時間が経過し、ユーザーに通知する時間です。
ISO 8601の形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

createdTime

タイマーが作成された時刻です。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

updatedTime

タイマーが最後に一時停止、再開、停止された時刻です。存在しない場合は、createdTimeに設定されます。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

remainingTimeWhenPaused

(任意)タイマーが一時停止された場合の残り時間を指定します。
ISO 8601のキュレーション形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

HTTPステータスコード

ステータス 説明

200 OK

応答本文にタイマーの情報が含まれています。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

タイマーの一覧を取得する

任意のAlexa搭載デバイスを使用してこのスキルでユーザー用に作成されたすべてのタイマーを取得します。

リクエスト

タイマーを取得するには、timersリソースに対してGETリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

GET /v1/alerts/timers
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}
Accept: application/json

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

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

access token

ヘッダー

ユーザーのアクセストークンです。
セッション内のリクエストの場合は、apiAccessTokenに設定します。
セッション外のリクエストの場合は、LWAトークンに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKと共に、設定時間が最短のものから最長のものの順に並べられたタイマーのリストが返されます。タイマーがない場合、AlexaはtotalCountが0に設定された空のリストを返します。

エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。

応答本文の例

{
    "timers": [{
            "id": "timer.id.1",
            "status": "ON",
            "duration": "PT10M",
            "triggerTime": "2019-12-03T10:25:30Z",
            "createdTime": "2019-12-03T10:15:30Z",
            "updatedTime": "2019-12-03T10:15:30Z"
        },
        {
            "id": "timer.id.2",
            "status": "PAUSED",
            "duration": "PT15M",
            "timerLabel": "ピザ",
            "createdTime": "2019-12-03T10:15:30Z",
            "updatedTime": "2019-12-03T10:12:03Z",
            "remainingTimeWhenPaused": "PT3M3S"
        }
    ],
    "totalCount": 2,
    "nextToken": null
}

応答本文のプロパティ

プロパティ 説明

timers[]

タイマーのリストです。

オブジェクトの配列

timers[].id

タイマーを一意に識別します。

文字列

timers[].status

タイマーの状態です。
有効な値は、 ONOFFPAUSEDです。

  • ON - タイマーはアクティブで、triggerTimeに鳴動するか、triggerTimeが過ぎている場合は現在鳴動中です。
  • OFF - タイマーの設定時間が経過したか、ユーザーがタイマーをキャンセルしました。
  • PAUSED - タイマーはオンになっていましたが、現在一時停止されています。ユーザーはこのタイマーを再開できます。

文字列

timers[].duration

タイマーの継続時間です。
ISO 8601の期間形式(PT*H*H*M*M*SS*S)で定義されます。

文字列

timers[].timerLabel

(任意)タイマーの名前です。ユーザーはこの名前でタイマーを参照できます。
有効な値は、 最大256文字です。

文字列

timers[].triggerTime

タイマーの設定時間が経過し、ユーザーに通知する時間です。
ISO 8601の形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

timers[].createdTime

タイマーが作成された時刻です。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

timers[].updatedTime

タイマーが最後に一時停止、再開、停止された時刻です。存在しない場合は、createdTimeに設定されます。
ISO 8601形式で定義し、YYYY-MM-DDThh:mm:ssZとなります。

文字列

timers[].remainingTimeWhenPaused

(任意)タイマーが一時停止された場合の残り時間を指定します。
ISO 8601のキュレーション形式(YYYY-MM-DDThh:mm:ssZ)で定義されます。

文字列

totalCount

タイマーの合計数です。

整数

nextToken

返すタイマーがほかにもあるかどうかを示します。現時点では、ページ分割はサポートされていません。常にnullに設定されます。

文字列

HTTPステータスコード

ステータス 説明

200 OK

応答本文にタイマーのリストが含まれています。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

タイマーを一時停止する

現在のAlexa搭載デバイスで指定のタイマーを一時停止し、残り時間を保存します。ユーザーがタイマーを再開すると、タイマーは続行されます。

リクエスト

タイマーを一時停止するには、timersリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

POST /v1/alerts/timers/{id}/pause
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

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

id

パス

タイマーIDです。

文字列

access token

ヘッダー

ユーザーのアクセストークンです。
apiAccessTokenに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。status = PAUSEDのタイマーを一時停止しようとすると、Alexaはcode = TIMER_ALREADY_PAUSEDHTTP 400 Bad Requestを返します。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

200 OK

指定されたタイマーが正常に一時停止されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

タイマーを再開する

一時停止したタイマーを再開します。ユーザーがタイマーをキャンセルまたは再度一時停止しない限り、タイマーは残り時間の経過後に作動します。

リクエスト

タイマーを再開するには、timersリソースに対してPOSTリクエストを実行します。

リクエストパスとリクエストヘッダーの例

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

POST /v1/alerts/timers/{id}/resume
Host: api.amazonalexa.com
Content-Type: application/json
Authorization: Bearer {access token}

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

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

id

パス

タイマーIDです。

文字列

access token

ヘッダー

ユーザーのアクセストークンです。
apiAccessTokenに設定します。

文字列

リクエスト本文の例

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

リクエスト本文のプロパティ

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

応答

正常に完了すると、HTTP 200 OKが返されます。エラーの場合は、適切なHTTPステータスコードが返され、応答の本文にエラーコードと人が読める形式のメッセージが追加されます。statusPAUSEDに設定されていないタイマーを再開しようとすると、Alexaはcode = TIMER_IS_NOT_PAUSEDHTTP 400 Bad Requestを返します。

応答本文の例

応答の本文はありません。

応答本文のプロパティ

応答の本文はありません。

HTTPステータスコード

ステータス 説明

200 OK

指定されたタイマーが正常に再開されました。

400 Bad Request

リクエスト本文の1つ以上のプロパティが無効であることを示します。
以下は、エラーコードとメッセージを含む応答本文の例です。

{
     "message": "リクエストの時間形式が正しくありません。",
     "code": "INVALID_DURATION_FORMAT"
}

401 Unauthorized

リクエストに認可トークンが含まれていないか、トークンが無効または有効期限切れです。または、リソースに対するアクセス権限がクライアントにありません。

403 Forbidden

認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。たとえば、作成されたタイマーが最大件数(25件)に達している場合などです。

404 Not Found

リクエストされたリソースが見つからないか、タイマーが存在しません。

429 Too Many Requests

スキルが許可されたレート制限(単位時間あたりの指定されたリクエスト数)を超過しています。リクエストの再試行には指数バックオフを使用します。

500 Server Error

サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。

503 Service Unavailable

サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。

オブジェクトの定義

オペレーション

Operationオブジェクトは、タイマーの設定時間が経過したときのAlexaの動作を定義します。

プロパティ 説明 必須

type

タイマーの設定時間が経過したら、Alexaはこのタイプ値に基づいて、チャイム音を鳴らしたり、アナウンスのテキストを読み上げたり、Skill Connectionsのタスクを起動したりします。
有効な値は、 NOTIFY_ONLYANNOUNCELAUNCH_TASKです。

文字列

textToAnnounce[]

アナウンスのテキストとロケール情報です。
type = ANNOUNCEの場合にのみ有効です。
playAudiblefalseの場合、Alexaはタイマーの設定時間が経過したらテキストを読み上げます。playAudibletrueの場合、Alexaはユーザーがタイマーを解除したらテキストを読み上げます。

オブジェクトの配列

textToAnnounce[].text

タイマーの設定時間が経過したときにAlexaが読み上げるテキストです。

文字列

textToAnnounce[].locale

アナウンスで適用されるロケールです。

文字列

task

カスタムタスクに関する情報です。
type = LAUNCH_TASKの場合にのみ有効です。

オブジェクト

task.name

カスタムタスクの名前です。

文字列

task.version

タスクのバージョンです。

文字列

task.input

Alexaがタスクを起動するときに含めるカスタムタスクの情報です。
キーと値のペアの形式で指定します。

オブジェクト

textToConfirm[]

確認アナウンスのテキストとロケール情報です。ユーザーはタスクを承認または拒否する必要があります。
type = LAUNCH_TASKの場合にのみ有効です。
playAudiblefalseの場合、Alexaはタイマーの設定時間が経過したらテキストを読み上げます。playAudibletrueの場合、Alexaはユーザーがタイマーを解除したらテキストを読み上げます。

オブジェクトの配列

textToConfirm[].text

別のスキルに接続してタスクを完了させるかどうかのプロンプトをユーザーに出す目的でAlexaが読み上げるテキストです。
テキストには{continueWithSkillName}を含める必要があります。

文字列

textToConfirm[].locale

アナウンスで適用されるロケールです。

文字列