Bluetooth API Reference

The Bluetooth API enables you to get Bluetooth feature properties and to unpair Bluetooth devices from an Alexa-enabled device.

API endpoint

The endpoint of the Bluetooth API is https://api.amazonalexa.com.

Authentication

Each API request must have an authorization header whose value is the access token retrieved from Login with Amazon (LWA).

Operations

The Bluetooth API includes the following operations.

Operation HTTP Method and URI

Get Bluetooth features

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

Unpair all Bluetooth devices from the Alexa-enabled device

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

Get Bluetooth features

Gets Bluetooth feature properties, operations, and the configuration.

This operation is available in the following countries.

Healthcare Hospitality Residential Senior Living Core

None

US, UK, FR, CA, IT, DE

US, CA

US, UK, FR, CA, IT, DE

None

Request

To get the Bluetooth feature properties, operations, and configuration, you make a GET request to the /v2/endpoints/{id}/features/bluetooth resource.

Request header example

Copied to clipboard.

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

Request header parameters

Parameter Description Type Required

access token

LWA token.

String

Yes

id

Endpoint identifier. The format of the ID must be amzn1.alexa.endpoint.{id}.

String

Yes

Request body example

The request has no body.

Request body parameters

The request has no body.

Response

A successful response returns HTTP 200.

Response body example

The following example shows a response.

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

Response body parameters

Parameter Description Type

properties

Supported properties accessible to the caller. Currently limited to none.

List of objects

operations

Supported operations accessible to the caller. Currently limited to unpair.

List of operation objects

operations[*].name

Operation name. Currently limited to unpair.

String

operations[*].path

Full path to invoke the operation.

String

configuration

Configuration data accessible to the caller. Currently limited none.

List of configuration objects

HTTP status codes

Status Description

200 Success

The request succeeded.

400 Bad Request

The request was malformed or missing required parameters.

401 Unauthorized

Authorization token is invalid, expired, or doesn't have access to the resource.

403 Forbidden

The request couldn't complete because of the client doesn't have permission to perform the operation.

404 Not Found

The endpoint is not found or the specified feature or operation isn't available on the endpoint.

429 Too Many Requests

User has exceeded the permitted rate limit (specified number of requests per unit of time).

500 Internal Server Error

Server has encountered an error.

Unpair all Bluetooth devices from the Alexa-enabled device

Unpairs all of the Bluetooth devices from the Alexa-enabled device.

This operation is available in the following countries.

Healthcare Hospitality Residential Senior Living Core

None

US, UK, FR, CA, IT, DE

US, CA

US, UK, FR, CA, IT, DE

None

Request

To unpair the Bluetooth devices, you make a POST request to the /v2/endpoints/{endpointId}/features/bluetooth/unpair resource.

Request header example

Copied to clipboard.

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

Request header parameters

Parameter Description Type Required

access token

LWA token.

String

Yes

endpointId

Endpoint identifier. The format of the ID must be amzn1.alexa.endpoint.{id}.

String

Yes

Request body example

The request has no body.

Request body parameters

The request has no body.

Response

A successful response returns HTTP 202.

Response body example

The response has no body.

Response body parameters

The response has no body.

HTTP status codes

Status Description

202 OK

Devices were unpaired.

400 Bad Request

The request was malformed or missing required parameters.

401 Unauthorized

Authorization token is invalid, expired, or doesn't have access to the resource.

403 Forbidden

The request couldn't complete because of the client doesn't have permission to perform the operation.

404 Not Found

The endpoint is not found or the specified feature or operation isn't available on the endpoint.

429 Too Many Requests

User has exceeded the permitted rate limit (specified number of requests per unit of time).

500 Internal Server Error

Server has encountered an error.

503 Service Unavailable

Endpoint is not reachable