Azure Communication Services チャット
Azure Communication Services のチャット機能を利用するためのコネクタ。
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | マイクロソフト |
| [URL] | https://azure.microsoft.com/services/communication-services |
| メール | acssolutions@microsoft.com |
| Connector Metadata | |
|---|---|
| 発行者 | マイクロソフト |
| Web サイト | https://azure.microsoft.com/services/communication-services |
| プライバシー ポリシー | https://privacy.microsoft.com |
| カテゴリー | 通信 |
Azure Communication Services Chat は、クロスプラットフォーム アプリケーションにリアルタイムのテキスト通信を追加するのに役立ちます。
前提条件
続行するには、次のものが必要です。
- カスタム コネクタ機能を備えた Microsoft Power Apps または Power Automate プラン
- Azure サブスクリプション
- Azure Communication Services リソース
資格情報の入手方法
1 Azure Communication Services リソースの設定
2 接続文字列の認証
- Azure Communication Services リソース エンドポイント URL を使用して新しい接続を作成できます。
コネクタの使用を開始する
Azure Communication Services リソースを設定した後、ユーザー アクセス トークンを生成します。 このトークンはコネクタ アクションに使用します。
既知の問題と制限事項
現時点では、既知の問題や制限はありません。
よくあるご質問
- アクセス トークンはどのように生成するのですか?
- Azure Communication Services Identity Connector を使用して、新しいユーザー ID を生成したり、ユーザーのアクセス トークンを更新したりできます。 テスト用のポータルを介して手動で行うこともできます。
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | 説明 | 必須 |
|---|---|---|---|
| エンドポイント URL | securestring | Azure Communication Services エンドポイント URL。 | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| チャット スレッド メッセージを一覧表示する |
チャット スレッドからメッセージを一覧表示します。 |
| チャット スレッドにメッセージを送信する |
チャット スレッドにメッセージを送信します。 |
| チャット スレッドの参加者を一覧表示する |
チャット スレッドの参加者を一覧表示します。 |
| チャット スレッドの参加者を削除する |
チャット スレッドの参加者を削除します。 |
| チャット スレッドの参加者を追加する |
参加者をチャット スレッドに追加します。 |
| チャット スレッドを一覧表示する |
チャット スレッドを一覧表示します。 |
| チャット スレッドを作成する |
チャット スレッドを作成します。 |
| チャットスレッドのプロパティを取得する |
チャットスレッドのプロパティを取得します。 |
チャット スレッド メッセージを一覧表示する
チャット スレッドからメッセージを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
|
開始時間
|
startTime | string |
メッセージを取得するための RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) の開始時刻。 |
|
|
Max Page Size
|
maxPageSize | string |
ページ当たり返されるメッセージの最大数です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メッセージ リスト
|
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
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
|
コンテンツ
|
content | True | string |
メッセージ コンテンツ。 |
|
名前
|
senderDisplayName | True | string |
メッセージの送信者の表示名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
id
|
id | string |
id |
チャット スレッドの参加者を一覧表示する
チャット スレッドの参加者を一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
|
スキップする参加者の数
|
skip | string |
応答として、参加者を指定された位置までスキップします。 |
|
|
Max Participants Per Page
|
maxPageSize | string |
ページ当たり返される参加者の最大数です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
値
|
value | array of object |
参加者を取得します。 |
|
communicationIdentifier
|
value.communicationIdentifier | CommunicationIdentifier |
通信識別子。 |
|
名前
|
value.displayName | string |
チャット参加者の表示名。 |
|
時間
|
value.shareHistoryTime | string |
チャット履歴が共有される RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) の時間。 |
|
次のリンク
|
nextLink | string |
取得できるチャット参加者が他にもある場合は、次のリンクにデータが入力されます。 |
チャット スレッドの参加者を削除する
チャット スレッドの参加者を削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
|
ユーザー ID
|
id | string |
チャット スレッドの参加者を追加する
参加者をチャット スレッドに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
|
ユーザー ID
|
id | string | ||
|
表示名
|
displayName | string |
チャット参加者の表示名。 |
|
|
時間
|
shareHistoryTime | string |
チャット履歴が共有される RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) の時間。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
invalidParticipants
|
invalidParticipants | array of object |
無効な参加者リスト。 |
|
対象
|
invalidParticipants.target | string |
Target Id |
|
Code
|
invalidParticipants.code | string |
エラー コードです。 |
|
メッセージ
|
invalidParticipants.message | string |
エラー メッセージ。 |
チャット スレッドを一覧表示する
チャット スレッドを一覧表示します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アクセス トークン
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
開始時間
|
startTime | string |
チャット スレッドを取得するための RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) の開始時刻。 |
|
|
Max Page Size
|
maxPageSize | integer |
ページ当たり返されるチャット スレッドの最大数です。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Chat Threads
|
value | array of object |
メッセージのコレクション |
|
ID
|
value.id | string |
チャットのスレッド ID。 |
|
トピック
|
value.topic | string |
チャット スレッド トピック。 |
|
last Message Received On
|
value.lastMessageReceivedOn | string |
最後のメッセージがサーバーに到着したときの RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) のタイム スタンプ。 |
|
Deleted On
|
value.deletedOn | string |
チャット スレッドが削除されたときの RFC3339 形式 (yyyy-MM-ddTHH:mm:ssZ) のタイム スタンプ。 |
|
次のリンク
|
nextLink | string |
取得できるチャット スレッドが他にもある場合は、次のリンクにデータが入力されます。 |
チャット スレッドを作成する
チャット スレッドを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
Chat Thread Topic
|
topic | True | string |
チャット スレッド トピック。 |
|
ユーザー ID
|
id | string | ||
|
名前
|
displayName | string |
チャット参加者の表示名。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
chatThread.id | string |
チャットのスレッド ID |
|
トピック
|
chatThread.topic | string |
Chat Thread Topic |
|
作成日
|
chatThread.createdOn | date-time |
通知作成時刻 |
|
createdByCommunicationIdentifier
|
chatThread.createdByCommunicationIdentifier | CommunicationIdentifier |
通信識別子。 |
チャットスレッドのプロパティを取得する
チャットスレッドのプロパティを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Access Token
|
Access-Token | True | string |
ユーザー アクセス トークン。 |
|
スレッド ID
|
chatThreadId | True | string |
チャットのスレッド ID。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | string |
チャットのスレッド ID。 |
|
トピック
|
topic | string |
チャット スレッド トピック。 |
|
作成日
|
createdOn | string |
スレッドが作成された時間。 |
|
Deleted On
|
deletedOn | string |
スレッドが削除された時間。 |
|
生 ID
|
createdByCommunicationIdentifier.rawId | string |
識別子の生 ID。 |
|
ID
|
createdByCommunicationIdentifier.communicationUser.id | string |
通信ユーザーの ID。 |
定義
CommunicationIdentifier
通信識別子。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ユーザー ID
|
communicationUser.id | string |