Bluetooth APIリファレンス

Bluetooth APIリファレンス

Bluetooth APIを使用すると、Bluetooth機能のプロパティを取得したり、Alexa搭載デバイスからBluetoothデバイスのペアリングを解除したりできます。

APIエンドポイント

Bluetooth APIのエンドポイントは、https://api.amazonalexa.comです。

認証

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

操作

Bluetooth APIには、以下の操作が用意されています。

操作 HTTPメソッドとURI

Bluetooth機能を取得する

GET /v2/endpoints/{id}/features/bluetooth

Alexa搭載デバイスからBluetoothデバイスのペアリングをすべて解除する

POST /v2/endpoints/{endpointId}/features/bluetooth/unpair

Bluetooth機能を取得する

Bluetooth機能のプロパティ、操作、設定を取得します。

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

Healthcare Hospitality Residential Senior Living Core

なし

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

なし

リクエスト

Bluetooth機能のプロパティ、操作、設定を取得するには、/v2/endpoints/{id}/features/bluetoothリソースに対してGETリクエストを送信します。

リクエストヘッダーの例

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

GET /v2/endpoints/{id}/features/bluetooth HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer {access token}

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

パラメーター 説明 型 必須

access token

LWAトークンです。

文字列

◯

id

エンドポイントIDです。IDはamzn1.alexa.endpoint.{id}の形式で指定する必要があります。

文字列

◯

リクエスト本文の例

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

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

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

応答

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

応答本文の例

以下は、応答の例です。

HTTP/1.1 200 OK
{
  "operations": [
    {
       "name": "unpair",
       "path": "/v2/endpoints/{id}/features/bluetooth/unpair"
    }
   ]
}

応答本文のパラメーター

パラメーター 説明 型

properties

呼び出し元がアクセスできる、サポートされているプロパティです。現在、noneに限定されています。

オブジェクトのリスト

operations

呼び出し元がアクセスできる、サポートされている操作です。現在、unpairに限定されています。

Operationオブジェクトのリスト

operations[*].name

操作の名前です。現在、unpairに限定されています。

文字列

operations[*].path

操作を呼び出すための完全なパスです。

文字列

configuration

呼び出し元がアクセスできる設定データです。現在、noneに限定されています。

Configurationオブジェクトのリスト

HTTPステータスコード

ステータス 説明

200 Success

リクエストが成功しました。

400 Bad Request

リクエストの形式が正しくないか、必須パラメーターがありません。

401 Unauthorized

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

403 Forbidden

操作を実行する権限がクライアントにないため、リクエストを完了できませんでした。

404 Not Found

エンドポイントが見つからないか、指定された機能または操作がエンドポイントで使用できません。

429 Too Many Requests

ユーザーが、許可されたレート制限（単位時間あたりの規定のリクエスト数）を超過しています。

500 Internal Server Error

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

Alexa搭載デバイスからBluetoothデバイスのペアリングをすべて解除する

Alexa搭載デバイスからBluetoothデバイスのペアリングをすべて解除します。

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

Healthcare Hospitality Residential Senior Living Core

なし

米国、英国、フランス、カナダ、イタリア、ドイツ

米国、カナダ

米国、英国、フランス、カナダ、イタリア、ドイツ

なし

リクエスト

Bluetoothデバイスのペアリングを解除するには、/v2/endpoints/{endpointId}/features/bluetooth/unpairリソースに対してPOSTリクエストを送信します。

リクエストヘッダーの例

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

POST /v2/endpoints/{endpointId}/features/bluetooth/unpair HTTP/1.1
Host: api.amazonalexa.com
Authorization: Bearer {access token}

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

パラメーター 説明 型 必須

access token

LWAトークンです。

文字列

◯

endpointId

エンドポイントIDです。IDはamzn1.alexa.endpoint.{id}の形式で指定する必要があります。

文字列

◯

リクエスト本文の例

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

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

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

応答

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

応答本文の例

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

応答本文のパラメーター

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

HTTPステータスコード

ステータス 説明

202 OK

デバイスのペアリングが解除されました。

400 Bad Request

リクエストの形式が正しくないか、必須パラメーターがありません。

401 Unauthorized

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

403 Forbidden

操作を実行する権限がクライアントにないため、リクエストを完了できませんでした。

404 Not Found

エンドポイントが見つからないか、指定された機能または操作がエンドポイントで使用できません。

429 Too Many Requests

ユーザーが、許可されたレート制限（単位時間あたりの規定のリクエスト数）を超過しています。

500 Internal Server Error

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

503 Service Unavailable

エンドポイントに到達できません。

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