コミュニケーション機能REST APIリファレンス
Alexaコミュニケーション機能REST APIを使用すると、Alexa Smart Properties(ASP)のルーム用のコミュニケーション機能プロファイルを作成および管理できます。これらのプロファイルを使用して、施設のルーム間でAlexa搭載デバイスによる通話を行うことができます。通話アドオンの詳細については、Alexa Smart Propertiesで通話するを参照してください。
ルーム内のAlexa搭載デバイスを識別するには、ユニットIDの代わりにコミュニケーション機能プロファイルを使用します。ルーム用のコミュニケーション機能プロファイルを作成したら、それをほかのルームのアドレス帳に連絡先として追加できます。詳細については、アドレス帳REST APIリファレンスを参照してください。
APIエンドポイント
組織が所在する国に応じて、リクエストヘッダーのHost
パラメーターを、以下のいずれかのAPIエンドポイントに設定してください。
国 | エンドポイント |
---|---|
カナダ、米国 |
|
ドイツ、スペイン、フランス、イタリア、英国 |
|
日本 |
|
認証
すべてのAPIリクエストにはAuthorizationヘッダーが必要であり、その値にはLogin with HAQM(LWA)から取得したアクセストークンが入ります。詳細については、APIアクセスを管理するを参照してください。
操作
コミュニケーション機能APIでは、以下の操作タイプがサポートされています。
- コミュニケーション機能プロファイルの管理 - 通話をサポートするには、ユニットごとにコミュニケーション機能プロファイルを作成する必要があります。
- 通話設定の管理 - 各ユニットとコミュニケーション機能プロファイルの呼びかけ設定を構成したり、2つの施設ユニット間の通話を無効にするブロックルールを定義したりできます。
コミュニケーション機能プロファイルの管理
操作 | HTTPメソッドとURI |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
|
通話設定の管理
操作 | HTTPメソッドとURI |
---|---|
| |
| |
| |
|
コミュニケーション機能プロファイルを作成する
ユニットでの通話をサポートするコミュニケーション機能プロファイルを作成します。応答には、profileId
と呼ばれるユニットの一意の識別子が含まれます。このprofileId
を、ほかのユニットのアドレス帳に連絡先として追加できます。
必要に応じてプロファイルの名前を指定できます。これはユニットの表示名として使用されます。このユニットのゲストが電話をかけると、指定した名前が連絡先のAlexa搭載デバイスとAlexaアプリに表示されます。ほかのユニットのゲストからこのユニットに着信できるようにするには、ほかのユニットのアドレス帳にこのユニットの名前を追加します。ユニットのプロファイルが既に存在する場合、この操作はユニットの既存のprofileId
を返し、既存の名前とは異なるプロファイル名が指定されていればプロファイル名を更新します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
プロファイルを作成するには、/v1/communications/profile
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v1/communications/profile HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.101"
},
"name": "101号室"
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
コミュニケーション機能プロファイルを作成する対象のエンティティ(ユニットなど)。 |
オブジェクト |
◯ |
|
エンティティのタイプ。 |
文字列 |
◯ |
|
ユニットを識別します。 |
文字列 |
◯ |
|
コミュニケーション機能プロファイルの表示名。
|
文字列 |
✕ |
応答
正常に完了すると、HTTP 200 OK
と共に、コミュニケーション機能プロファイルIDが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.101"
},
"profileId": {
"profileId": "amzn1.alexa.communications.profile.did.1234"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
コミュニケーション機能プロファイルを作成する対象のエンティティ(ユニットなど)。 |
オブジェクト |
|
エンティティのタイプ。 |
文字列 |
|
ユニットを識別します。 |
文字列 |
|
ユニットの新しいコミュニケーション機能プロファイル。 |
オブジェクト |
|
コミュニケーション機能プロファイルを一意に識別します。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定されたエンティティのコミュニケーション機能プロファイルIDが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
コミュニケーション機能プロファイルを一括で作成する
最大100ユニットのコミュニケーション機能プロファイルを1回のリクエストで作成します。各ユニットに一意のprofileId
が割り当てられます。このprofileId
を、ほかのユニットのアドレス帳に連絡先として追加できます。
必要に応じてプロファイルの名前を指定できます。これはユニットの表示名として使用されます。このユニットのゲストが電話をかけると、指定した名前が連絡先のAlexa搭載デバイスとAlexaアプリに表示されます。ほかのユニットのゲストからこのユニットに着信できるようにするには、ほかのユニットのアドレス帳にこのユニットの名前を追加します。ユニットのプロファイルが既に存在する場合、この操作はユニットの既存のprofileId
を返し、既存の名前とは異なるプロファイル名が指定されていればプロファイル名を更新します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
複数のプロファイルを作成するには、/v1/communications/profiles/batch
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v1/communications/profiles/batch HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"items": [{
"itemId": 1,
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.201"
},
"name": "201号室"
},
{
"itemId": 2,
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.202"
},
"name": "202号室"
}
]
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
コミュニケーション機能プロファイルを割り当てるユニットのリスト。 |
オブジェクトの配列 |
◯ |
|
割り当ての一意のID。 |
整数 |
◯ |
|
コミュニケーション機能プロファイルを作成する対象のエンティティ(ユニットなど)。 |
オブジェクト |
◯ |
|
エンティティのタイプ。 |
文字列 |
◯ |
|
ユニットを識別します。 |
文字列 |
◯ |
|
コミュニケーション機能プロファイルの表示名。
|
文字列 |
✕ |
応答
正常に完了すると、HTTP 200 OK
と共に、コミュニケーション機能プロファイルIDのリストが返されます。リクエスト全体が失敗した場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。個々の項目でエラーが発生した場合、応答本文には成功とエラーの項目が含まれます。
応答本文の例
以下の例は成功応答を示し、各ユニットにプロファイルIDが割り当てられています。
以下の例は、個々の項目レベルで成功とエラーメッセージの両方を含む応答本文を示しています。results
プロパティとerrors
プロパティは同じ応答に共存できます。
以下の例は、すべての項目が失敗した応答本文を示しています。
以下の例は、個々の項目ではなくリクエスト全体がエラーになった応答本文を示しています。
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
成功した結果のリスト。 |
オブジェクトの配列 |
|
(オプション)リクエストで指定された一意のID。リクエスト項目とレスポンス項目を関連付けるために使用できます。リクエストレベルのエラーの場合は含まれません。 |
整数 |
|
プロファイルの作成対象のエンティティ(ユニットなど)。 |
オブジェクト |
|
エンティティのタイプ。 |
文字列 |
|
ユニットを識別します。 |
文字列 |
|
コミュニケーション機能プロファイルを一意に識別します。 |
文字列 |
|
(オプション)エラーの結果のリスト。 |
オブジェクトの配列 |
|
(オプション)リクエストで指定された一意のID。リクエスト項目とレスポンス項目を関連付けるために使用できます。 |
整数 |
|
失敗したリクエスト項目に対するHTTP応答コード。 |
整数 |
|
発生したエラーのタイプ。 |
文字列 |
|
読み取り可能なエラーメッセージ。エラーメッセージはデバッグやログ記録のみを目的としたものです。ユーザーには表示しないようにする必要があります。エラーの説明の内容に依存するビジネスロジックは構築しないでください。 |
文字列 |
個々の項目に対するエラーのプロパティ値
status
|
errorCode
|
errorDescription
|
---|---|---|
|
|
UnitId is not valid. Please check your Input.(unitIdが無効です。入力を確認してください。) |
|
|
Given |
|
|
Entity is mandatory.(entityは必須です。) |
|
|
EntityType must be between 1 and 10 characters.(entityTypeは1~10文字である必要があります。) |
|
|
EntityId must be between 1 and 1000 characters.(entityIdは1~1000文字である必要があります。) |
|
|
Name must consist of 1 to 128 characters.(nameは1~128文字である必要があります。) |
|
|
Requested action cannot be performed as you don't have access over the specified resource.(指定されたリソースにアクセスする権限がないため、リクエストされたアクションを実行できません。) |
|
|
An internal service error occurred.(内部サービスエラーが発生しました。) |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
コミュニケーション機能プロファイルIDのリストが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
コミュニケーション機能プロファイルを削除する
指定されたコミュニケーション機能プロファイルを削除します。この操作では、以下のアクションが実行されます。
- コミュニケーション機能を無効にする。
- ユニットに割り当てられている
profileId
を削除する。 profileID
が連絡先となっているアドレス帳に含まれる連絡先をすべて削除する。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
プロファイルを削除するには、/v1/communications/profile
リソースに対してDELETE
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
DELETE /v1/communications/profile/{profileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
コミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
コミュニケーション機能プロファイルが正常に削除されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
コミュニケーション機能プロファイルを取得する
指定されたコミュニケーション機能プロファイルの詳細を取得します。これには、プロファイルに関連付けられているユニットIDが含まれます。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
プロファイルを取得するには、/v1/communications/profile
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v1/communications/profile/{profileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
コミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、コミュニケーション機能プロファイルが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.101"
},
"name": "101号室",
"profileId": {
"profileId": "amzn1.alexa.communications.profile.did.1234"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
コミュニケーション機能プロファイルを取得する対象のエンティティ(ユニットなど)。 |
オブジェクト |
|
エンティティのタイプ。 |
文字列 |
|
ユニットを識別します。 |
文字列 |
|
コミュニケーション機能プロファイルの表示名。 |
文字列 |
|
ユニットのコミュニケーション機能プロファイル。 |
オブジェクト |
|
コミュニケーション機能プロファイルを一意に識別します。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
コミュニケーション機能プロファイルが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
エンティティを使用してコミュニケーション機能プロファイルを取得する
指定されたエンティティに関連付けられているコミュニケーション機能プロファイルを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
プロファイルを取得するには、/v1/communications/profile
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v1/communications/profile?entity.type={type}&entity.id={id}&maxResults={maxResults}&nextToken={nextToken} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
クエリ |
エンティティのタイプ。 |
文字列 |
◯ |
|
クエリ |
ユニットID。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、指定されたユニットのコミュニケーション機能プロファイルIDが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"entity": {
"type": "UNIT",
"id": "amzn1.alexa.unit.did.101"
},
"name": "101号室",
"profileId": {
"profileId": "amzn1.alexa.communications.profile.did.1234"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
コミュニケーション機能プロファイルを取得する対象のエンティティ(ユニットなど)。 |
オブジェクト |
|
エンティティのタイプ。 |
文字列 |
|
ユニットを識別します。 |
文字列 |
|
コミュニケーション機能プロファイルの表示名。 |
文字列 |
|
ユニットのコミュニケーション機能プロファイル。 |
オブジェクト |
|
コミュニケーション機能プロファイルを一意に識別します。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
コミュニケーション機能プロファイルが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
コミュニケーション機能プロファイルを更新する
コミュニケーション機能プロファイルの表示名を更新します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
米国 |
リクエスト
プロファイルを更新するには、/v1/communications/profile/{profileId}
リソースに対してPUT
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
PUT /v1/communications/profile/{profileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
コミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"name": "14-101号室"
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
コミュニケーション機能プロファイルの表示名。
|
文字列 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
プロファイル名が正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
相互関連付けを作成する
指定されたユニットと外部連絡先との相互関連付けを作成します。この関連付けにより、外部連絡先から、ユニットに関連付けられているAlexa搭載デバイスへの着信が可能になります。関連付けを作成するには、施設ユニットに関連付けられているアドレス帳に外部連絡先を追加してから、ルームとその連絡先との間に相互関連付けを作成します。
この操作は、連絡先IDで識別される外部ユーザーのアドレス帳に、ユニットのコミュニケーション機能プロファイルを連絡先として追加します。その後、外部連絡先のAlexaアプリとHAQM Echoデバイスに、新しい相互連絡先について通知するAlexaメッセージを送信します。外部連絡先に複数の電話番号がある場合、この操作は、有効な電話番号のそれぞれに対して相互関連付けの作成を試みます。少なくとも1つの電話番号との関連付けが成功すると、操作は成功します。既に相互関連付けが存在する電話番号については、重複する連絡先は作成されず、外部連絡先へのメッセージ送信も行われません。
関連付けの作成後、外部連絡先は、Alexa搭載デバイスやAlexaアプリの連絡先リストでユニットへの連絡先を表示したり、画面付きのAlexa搭載デバイスで音声や画面上のコントロールを使用してユニットに電話をかけたりできます。外部連絡先は、必要に応じてユニットの連絡先をブロックできます。着信機能では、メッセージと呼びかけ通話はサポートされません。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
なし |
日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
なし |
リクエスト
関連付けを作成するには、/v1/communications/profile/{profileId}/reciprocalAssociations
リソースに対してPOST
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
POST /v1/communications/profile/{profileId}/reciprocalAssociations HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
ユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"contact": {
"id": "amzn1.alexa.contact.did.1101"
}
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
ユニットに関連付ける外部連絡先を識別します。 |
オブジェクト |
◯ |
|
外部連絡先を識別します。 |
文字列 |
◯ |
応答
正常に完了すると、HTTP 201 Created
と共に、関連付けが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"profileId": "amzn1.alexa.communications.profile.did.1234",
"contactId": "amzn1.alexa.contact.did.1101"
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
パス |
コミュニケーション機能プロファイルを識別します。 |
文字列 |
|
|
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
相互関連付けが正常に作成されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
相互関連付けのステータスを削除する
外部連絡先からユニットへの着信を無効にするには、ユニットと外部連絡先との相互関連付けを削除します。この操作は、指定された連絡先のアドレス帳から指定されたユニットを削除し、連絡先のAlexaアプリとHAQM EchoデバイスにAlexaメッセージを送信して、関連付けが削除されたことを連絡先に通知します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
なし |
日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
なし |
リクエスト
関連付けを削除するには、/v1/communications/profile/{profileId}/reciprocalAssociations
リソースに対してDELETE
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
DELETE /v1/communications/profile/{profileId}/reciprocalAssociations?contactId={contactId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
連絡先からの着信を無効にするユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
外部連絡先を識別します。 |
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
指定された連絡先の相互関連付けが正常に削除されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
相互関連付けを取得する
指定されたプロファイルと連絡先との相互関連付けのステータスを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
なし |
日本 |
米国、英国、フランス、カナダ、イタリア、ドイツ、スペイン、日本 |
なし |
リクエスト
関連付けを取得するには、/v1/communications/profile/{profileId}/reciprocalAssociations
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v1/communications/profile/{profileId}/reciprocalAssociations?contactId={contactId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
ユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
|
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、関連付けのステータスが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"results": [{
"contact": {
"contactId": "amzn1.alexa.contact.1101"
},
"status": "ENABLED"
}],
"paginationContext": {
"nextToken": "null"
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
連絡先のリスト。 |
オブジェクトの配列 |
|
連絡先を定義します。 |
オブジェクト |
|
|
文字列 |
|
指定された連絡先とプロファイルとの相互関連付けが存在するかどうかを示します。 |
文字列 |
|
返す結果がほかにもあるかどうかを示します。 |
オブジェクト |
|
応答が分割された場合に含まれます。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
関連付けのステータスが応答に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
ブロックルールを作成する
2つの施設ユニット間の通話とメッセージを有効または無効にするブロックルールを作成します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国 |
米国 |
米国 |
リクエスト
ブロックルールを作成するには、/v1/communications/profile/{profileId}/contacts/settings/Block
リソースに対してPUT
リクエストを実行します。このルールは、ターゲットユニットから、プロファイルIDで識別される指定されたユニットへの通話をブロックします。ただし、指定されたユニットからターゲットユニットへの通話は引き続き可能です。
リクエストヘッダーの例
PUT /v1/communications/profile/{profileId}/contacts/settings/Block?alexaCommunicationProfileId={alexaCommunicationProfileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストのヘッダーとパスのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
呼びかけ設定を更新するユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
|
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"value": "ENABLED"
}
リクエスト本文のプロパティ
パラメーター | 説明 | 型 | 必須 |
---|---|---|---|
|
ユニットへの通信を有効にするかブロックするかを示す設定。有効な値は、 |
文字列 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
応答の本文はありません。
応答本文のパラメーター
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
リクエストが成功しました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。 |
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
ブロックルール設定を取得する
施設ユニット間の着信とメッセージを有効または無効にするブロックルールを取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
米国 |
米国 |
米国 |
リクエスト
ブロックルールを取得するには、/v1/communications/profile/{profileId}/contacts/settings/Block?value={value}
リソースへのGET
リクエストを行います。
リクエストヘッダーの例
GET /v1/communications/profile/{profileId}/contacts/settings/Block?value={value}&alexaCommunicationProfileId={alexaCommunicationProfileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストのヘッダーとパスのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
呼びかけ設定を照会するユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
ターゲットユニットのコミュニケーション機能プロファイルを識別します。指定されていない場合、応答には、 |
文字列 |
✕ |
|
クエリ |
ブロックルール設定のステータスでフィルタリングします。 |
文字列 |
✕ |
|
クエリ |
応答で返される結果の最大数。 |
整数 |
✕ |
|
クエリ |
前回の応答で受け取ったトークン。 |
文字列 |
✕ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、各ターゲットプロファイルIDに対するブロックルール設定のリストが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
以下は、成功した応答の本文の例です。
{
"results": [{
"setting": "Block",
"contactId": "amzn1.alexa.contact.did.1101",
"alexaCommunicationProfileId": "amzn1.alexa.communications.profile.did.2101",
"value": "DISABLED"
},
{
"setting": "Block",
"contactId": "amzn1.alexa.contact.did.1102",
"alexaCommunicationProfileId": "amzn1.alexa.communications.profile.did.2102",
"value": "ENABLED"
}
],
"paginationContext": {
"nextToken": ""
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
連絡先と、関連付けられているブロック設定のリスト。 |
オブジェクトの配列 |
|
設定のタイプ。常に |
文字列 |
|
|
文字列 |
|
ターゲットユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
|
ブロック設定の現在のステータス。有効な値は、 |
文字列 |
|
返す結果がほかにもあるかどうかを示します。 |
オブジェクト |
|
応答が分割された場合に含まれます。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
連絡先ごとのブロック設定のリストが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
呼びかけ設定を取得する
指定されたプロファイルIDの、各ターゲットユニットに対する呼びかけ設定の現在の状態を取得します。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
なし |
なし |
なし |
リクエスト
設定を取得するには、/v1/communications/profile/{sourceProfileId}/contacts/settings/DropIn
リソースに対してGET
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
GET /v1/communications/profile/{profileId}/contacts/settings/DropIn?alexaCommunicationProfileId={alexaCommunicationProfileId}
HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
呼びかけ設定を照会するユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
ターゲットユニットのコミュニケーション機能プロファイルを識別します。指定されていない場合、応答には、 |
文字列 |
✕ |
|
クエリ |
呼びかけ設定のステータスでフィルタリングします。 |
文字列 |
✕ |
|
クエリ |
応答で返される結果の最大数。 |
整数 |
✕ |
|
クエリ |
前回の応答で受け取ったトークン。 |
文字列 |
✕ |
リクエスト本文の例
リクエストの本文はありません。
リクエスト本文のプロパティ
リクエストの本文はありません。
応答
正常に完了すると、HTTP 200 OK
と共に、各ターゲットプロファイルIDに対する呼びかけ設定のリストが返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
{
"results": [{
"setting": "DropIn",
"contactId": "amzn1.alexa.contact.did.1101",
"alexaCommunicationProfileId": "amzn1.alexa.communications.profile.did.2101",
"value": "DISABLED"
}],
"paginationContext": {
"nextToken": null
}
}
応答本文のプロパティ
プロパティ | 説明 | 型 |
---|---|---|
|
連絡先と、関連付けられている呼びかけ設定のリスト。 |
オブジェクトの配列 |
|
設定のタイプ。常に |
文字列 |
|
|
文字列 |
|
ターゲットユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
|
呼びかけ設定の現在のステータス。有効な値は、 |
文字列 |
|
返す結果がほかにもあるかどうかを示します。 |
オブジェクト |
|
応答が分割された場合に含まれます。 |
文字列 |
HTTPステータスコード
ステータス | 説明 |
---|---|
|
連絡先ごとの呼びかけ設定のリストが応答本文に含まれています。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
呼びかけ設定を設定する
指定された医療施設ユニット間の呼びかけ設定を有効または無効にします。呼びかけ設定を有効にすると、alexaCommunicationProfileId
にリンクされているターゲットユニットから、profileId
にリンクされているユニットへの呼びかけが可能になります。呼びかけでは、インターホンのように連絡先と直接つながることができます。呼びかけを設定するには、ソースユニット(病室など)とターゲットユニット(ナースステーションなど)の両方で、それぞれに関連付けられているアドレス帳に相手のユニットが連絡先として追加されている必要があります。呼びかけは、ターゲットユニットからソースユニットへの一方向です。
この操作は以下の国で使用できます。
Healthcare | Hospitality | Senior Living | Core |
---|---|---|---|
米国 |
なし |
なし |
なし |
リクエスト
呼びかけ設定を更新するには、/v1/communications/profile/{sourceProfileId}/contacts/settings/DropIn
リソースに対してPUT
リクエストを実行します。
リクエストパスとリクエストヘッダーの例
PUT /v1/communications/profile/{profileId}/contacts/settings/DropIn?alexaCommunicationProfileId={alexaCommunicationProfileId} HTTP/1.1
Host: api.amazonalexa.com
Accept: application/json
Authorization: Bearer {access token}
リクエストパスとリクエストヘッダーのパラメーター
パラメーター | 指定場所 | 説明 | 型 | 必須 |
---|---|---|---|---|
|
パス |
呼びかけ設定を更新するソースユニットのコミュニケーション機能プロファイルを識別します。 |
文字列 |
◯ |
|
クエリ |
|
文字列 |
◯ |
|
ヘッダー |
ユーザーのアクセストークン。 |
文字列 |
◯ |
リクエスト本文の例
{
"value": "ENABLED"
}
リクエスト本文のプロパティ
プロパティ | 説明 | 型 | 必須 |
---|---|---|---|
|
呼びかけ設定。有効な値は、 |
文字列 |
◯ |
応答
正常に完了すると、HTTP 204 No Content
が返されます。エラーの場合は、適切なHTTPステータスコードが応答として返され、エラーを説明するmessage
文字列が応答の本文に追加されます。
応答本文の例
応答の本文はありません。
応答本文のプロパティ
応答の本文はありません。
HTTPステータスコード
ステータス | 説明 |
---|---|
|
呼びかけ設定が正常に更新されました。 |
|
リクエスト本文の1つ以上のプロパティが無効であることを示します。
|
|
リクエストに認可トークンが含まれていないか、含まれているトークンが有効期限切れまたは無効です。または、リソースにアクセスする権限がありません。 |
|
認可トークンは有効ですが、リクエストされたオペレーションが許可されていないことを示します。 |
|
リクエストされたリソースが見つかりません。 |
|
許可されたレート制限(単位時間あたりのリクエスト数として指定された値)を超過しています。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーでエラーが発生しました。リクエストの再試行には指数バックオフを使用します。 |
|
サーバーがメンテナンスのために停止しているか、過負荷状態または受信リクエストを処理できない状態になっています。 |
関連トピック
最終更新日: 2024 年 05 月 28 日