Azure Communication Chat
Azure Communication Services チャット機能を利用するためのコネクタ。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Microsoft |
| URL | https://azure.microsoft.com/services/communication-services |
| acssolutions@microsoft.com |
| コネクタ メタデータ | |
|---|---|
| Publisher | Microsoft |
| Website | https://azure.microsoft.com/services/communication-services |
| プライバシー ポリシー | https://privacy.microsoft.com |
| カテゴリ | Communication |
Azure Communication Services チャットは、クロスプラットフォーム アプリケーションにリアルタイムのテキスト通信を追加するのに役立ちます。
[前提条件]
続行するには、次のものが必要です。
- カスタム コネクタ機能を備えた Microsoft Power Apps または Power Automate プラン
- Azure サブスクリプション
- Azure Communication Services リソース
資格情報を取得する方法
1 Azure Communication Services リソースを設定する
2 接続文字列認証
- Azure Communication Services リソース エンドポイント URL を使用して、新しい接続を作成できます。
コネクタの概要
Azure Communication Services リソースを設定した後、ユーザー アクセス トークンを生成します。 コネクタ アクションには、このトークンを使用します。
既知の問題と制限事項
現時点では、既知の問題や制限はありません。
FAQ
- アクセス トークンを生成する方法
- Azure Communication Services Identity Connector を使用して、新しいユーザー ID と、ユーザーの更新アクセス トークンを生成できます。 テスト用にポータルから手動で行うこともできます。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| エンドポイント URL | securestring | Azure Communication Services エンドポイント URL。 | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| チャット スレッド メッセージを一覧表示する |
チャット スレッドからのメッセージを一覧表示します。 |
| チャット スレッドにメッセージを送信する |
チャット スレッドにメッセージを送信します。 |
| チャット スレッドのプロパティを取得する |
チャット スレッドのプロパティを取得します。 |
| チャット スレッドのプロパティを更新する |
チャット スレッドのプロパティを更新します。 |
| チャット スレッドの削除 |
チャット スレッドを削除します。 |
| チャット スレッドの参加者を一覧表示する |
チャット スレッドの参加者を一覧表示します。 |
| チャット スレッドの参加者を追加する |
チャット スレッドに参加者を追加します。 |
| チャット スレッドを一覧表示する |
チャット スレッドを一覧表示します。 |
| チャット スレッドを作成する |
チャット スレッドを作成します。 |
| チャット スレッド参加者を削除する |
チャット スレッドから参加者を削除します。 |
チャット スレッド メッセージを一覧表示する
チャット スレッドからのメッセージを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
開始時刻
|
startTime | string |
メッセージを取得RFC3339開始時刻 (yyyy-MM-ddTHH:mm:ssZ)。 |
|
|
最大ページ サイズ
|
maxPageSize | string |
1 ページあたりに返されるメッセージの最大数。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メッセージ 一覧
|
value | array of object |
チャット メッセージのコレクション。 |
|
ID
|
value.id | string |
チャット メッセージの ID。 この ID はサーバーによって生成されます。 |
|
タイプ
|
value.type | string |
チャット メッセージの種類。 |
|
バージョン
|
value.version | string |
チャット メッセージのバージョン。 |
|
シーケンス ID
|
value.sequenceId | string |
会話内のチャット メッセージのシーケンス。 |
|
メッセージ
|
value.content.message | string |
チャット メッセージの内容。 |
|
initiatorCommunicationIdentifier
|
value.content.initiatorCommunicationIdentifier | CommunicationIdentifier |
通信識別子。 |
|
トピック
|
value.content.topic | string |
topicUpdated 型のメッセージのチャット メッセージ コンテンツ。 |
|
参加者
|
value.content.participants | array of object |
種類 participantAdded または participantRemoved のメッセージのチャット メッセージ コンテンツ。 |
|
communicationIdentifier
|
value.content.participants.communicationIdentifier | CommunicationIdentifier |
通信識別子。 |
|
送信者の表示名
|
value.senderDisplayName | string |
チャット メッセージ送信者の表示名。 このプロパティは、プッシュ通知の送信者名を設定するために使用されます。 |
|
作成日
|
value.createdOn | string |
チャット メッセージRFC3339サーバーに到着したときのタイムスタンプ (yyyy-MM-ddTHH:mm:ssZ)。 |
|
senderCommunicationIdentifier
|
value.senderCommunicationIdentifier | CommunicationIdentifier |
通信識別子。 |
|
次のリンク
|
nextLink | string |
取得できるチャット メッセージがさらに存在する場合は、次のリンクが設定されます。 |
チャット スレッドにメッセージを送信する
チャット スレッドにメッセージを送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
Content
|
content | True | string |
メッセージの内容。 |
|
名前
|
senderDisplayName | True | string |
メッセージ送信者の表示名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
id |
チャット スレッドのプロパティを取得する
チャット スレッドのプロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
チャット スレッド ID。 |
|
トピック
|
topic | string |
チャット スレッドのトピック。 |
|
作成日
|
createdOn | string |
スレッドが作成された時刻。 |
|
削除日
|
deletedOn | string |
スレッドが削除された時刻。 |
|
生 ID
|
createdByCommunicationIdentifier.rawId | string |
識別子の生 ID。 |
|
ID
|
createdByCommunicationIdentifier.communicationUser.id | string |
通信ユーザーの ID。 |
チャット スレッドのプロパティを更新する
チャット スレッドのプロパティを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
チャット スレッド トピック
|
topic | string |
チャット スレッドのトピック。 |
チャット スレッドの削除
チャット スレッドを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
チャット スレッドの参加者を一覧表示する
チャット スレッドの参加者を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
スキップする参加者の数
|
skip | string |
応答で指定した位置まで参加者をスキップします。 |
|
|
ページあたりの最大参加者数
|
maxPageSize | string |
ページごとに返される参加者の最大数。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
value
|
value | array of object |
チャット参加者。 |
|
communicationIdentifier
|
value.communicationIdentifier | CommunicationIdentifier |
通信識別子。 |
|
名前
|
value.displayName | string |
チャット参加者の表示名。 |
|
Time
|
value.shareHistoryTime | string |
チャット履歴の共有元RFC3339形式 (yyyy-MM-ddTHH:mm:ssZ) の時刻。 |
|
次のリンク
|
nextLink | string |
取得できるチャット参加者が増えた場合は、次のリンクが設定されます。 |
チャット スレッドの参加者を追加する
チャット スレッドに参加者を追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
ユーザーID
|
id | string | ||
|
表示される名前
|
displayName | string |
チャット参加者の表示名。 |
|
|
Time
|
shareHistoryTime | string |
チャット履歴の共有元RFC3339形式 (yyyy-MM-ddTHH:mm:ssZ) の時刻。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
invalidParticipants
|
invalidParticipants | array of object |
無効な参加者リストです。 |
|
目標
|
invalidParticipants.target | string |
ターゲット ID。 |
|
Code
|
invalidParticipants.code | string |
エラー コード。 |
|
メッセージ
|
invalidParticipants.message | string |
エラー メッセージ。 |
チャット スレッドを一覧表示する
チャット スレッドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
開始時刻
|
startTime | string |
チャット スレッドを取得するための開始時刻 (RFC3339形式 (yyyy-MM-ddTHH:mm:ssZ)。 |
|
|
最大ページ サイズ
|
maxPageSize | integer |
ページごとに返されるチャット スレッドの最大数。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
チャット スレッド
|
value | array of object |
チャット スレッドのコレクション。 |
|
ID
|
value.id | string |
チャット スレッド ID。 |
|
トピック
|
value.topic | string |
チャット スレッドのトピック。 |
|
最後に受信したメッセージ
|
value.lastMessageReceivedOn | string |
最後のメッセージがサーバーに到着したときのRFC3339形式のタイムスタンプ (yyyy-MM-ddTHH:mm:ssZ)。 |
|
削除日
|
value.deletedOn | string |
チャット スレッドが削除されたときのRFC3339形式のタイムスタンプ (yyyy-MM-ddTHH:mm:ssZ)。 |
|
次のリンク
|
nextLink | string |
取得できるチャット スレッドがさらに存在する場合は、次のリンクが設定されます。 |
チャット スレッドを作成する
チャット スレッドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
チャット スレッド トピック
|
topic | True | string |
チャット スレッドのトピック。 |
|
ユーザーID
|
id | string | ||
|
名前
|
displayName | string |
チャット参加者の表示名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
chatThread.id | string |
チャット スレッド ID |
|
トピック
|
chatThread.topic | string |
チャット スレッド トピック |
|
作成日
|
chatThread.createdOn | date-time |
チャット作成時間 |
|
createdByCommunicationIdentifier
|
chatThread.createdByCommunicationIdentifier | CommunicationIdentifier |
通信識別子。 |
チャット スレッド参加者を削除する
チャット スレッドから参加者を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセストークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャット スレッド ID。 |
|
ユーザーID
|
id | string |
定義
CommunicationIdentifier
通信識別子。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザーID
|
communicationUser.id | string |