Azure 通訊聊天
使用 Azure 通訊服務聊天功能的連接器。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft |
| URL | https://azure.microsoft.com/services/communication-services |
| acssolutions@microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
| 網站 | https://azure.microsoft.com/services/communication-services |
| 隱私策略 | https://privacy.microsoft.com |
| 類別 | Communication |
Azure 通訊服務聊天有助於將即時文字通訊新增至跨平臺應用程式。
先決條件
您將需要以下內容才能繼續:
- 具有自訂連接器功能的 Microsoft Power Apps 或 Power Automate 方案
- Azure 訂用帳戶
- Azure 通訊服務資源
如何取得認證
1 設定 Azure 通訊服務資源
2 連接字串驗證
- 您可以使用 Azure 通訊服務資源端點 URL 來建立新的連線。
開始使用連接器
設定 Azure 通訊服務資源之後,請產生使用者存取權杖。 將此權杖用於連接器動作。
已知問題與限制
目前沒有已知問題或限制。
FAQ
- 如何產生存取權杖?
- 您可以使用 Azure 通訊服務身分識別連接器來產生新的使用者身分識別,以及重新整理使用者的存取權杖。 您也可以透過入口網站手動執行此操作以進行測試。
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 端點 URL | securestring | Azure 通訊服務端點 URL。 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 傳送訊息至聊天串 |
將消息發送到聊天線程。 |
| 列出聊天串 |
列出聊天線程。 |
| 列出聊天對話串參與者 |
列出聊天線程中的參與者。 |
| 列出聊天討論串訊息 |
列出來自聊天線程的消息。 |
| 刪除聊天對話串 |
刪除聊天討論串。 |
| 取得聊天線程屬性 |
取得聊天線程的屬性。 |
| 建立聊天對話串 |
建立聊天線程。 |
| 新增聊天討論串參與者 |
將參與者新增至聊天線程。 |
| 更新聊天線程屬性 |
更新聊天線程的屬性。 |
| 移除聊天討論串參與者 |
從聊天線程中刪除參與者。 |
傳送訊息至聊天串
將消息發送到聊天線程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
Content
|
content | True | string |
訊息內容。 |
|
名稱
|
senderDisplayName | True | string |
訊息寄件者的顯示名稱。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
識別碼
|
id | string |
識別碼 |
列出聊天串
列出聊天線程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
開始時間
|
startTime | string |
以RFC3339格式 (yyyy-MM-ddTHH:mm:ssZ) 開始取得聊天線程的時間。 |
|
|
頁面大小上限
|
maxPageSize | integer |
每頁傳回的聊天線程數目上限。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
聊天線程
|
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 |
如果有更多聊天線程可以檢索,則會填入下一個連結。 |
列出聊天對話串參與者
列出聊天線程中的參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
跳過的參與者人數
|
skip | string |
將參與者跳到指定位置以回應。 |
|
|
每頁最多參與者
|
maxPageSize | string |
每頁要傳回的參與者人數上限。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
value
|
value | array of object |
聊天參與者。 |
|
通訊識別碼
|
value.communicationIdentifier | CommunicationIdentifier |
通訊識別碼。 |
|
名稱
|
value.displayName | string |
聊天參與者的顯示名稱。 |
|
Time
|
value.shareHistoryTime | string |
RFC3339格式 (yyyy-MM-ddTHH:mm:ssZ) 的時間,從中共享聊天記錄。 |
|
下一個連結
|
nextLink | string |
如果有更多聊天參與者可以擷取,則會填入下一個連結。 |
列出聊天討論串訊息
列出來自聊天線程的消息。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
開始時間
|
startTime | string |
以RFC3339格式 (yyyy-MM-ddTHH:mm:ssZ) 開始接收訊息的時間。 |
|
|
頁面大小上限
|
maxPageSize | string |
每頁要傳回的訊息數目上限。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訊息清單
|
value | array of object |
聊天消息的集合。 |
|
ID
|
value.id | string |
聊天訊息的 ID。 此 ID 是伺服器產生的。 |
|
類型
|
value.type | string |
聊天訊息類型。 |
|
版本
|
value.version | string |
聊天訊息的版本。 |
|
順序標識碼
|
value.sequenceId | string |
交談中聊天訊息的順序。 |
|
訊息
|
value.content.message | string |
聊天訊息內容。 |
|
發起器通訊識別碼
|
value.content.initiatorCommunicationIdentifier | CommunicationIdentifier |
通訊識別碼。 |
|
主題
|
value.content.topic | string |
topicUpdated 類型訊息的聊天訊息內容。 |
|
參與者
|
value.content.participants | array of object |
類型為 participantAdded 或 participantRemoved 的訊息的聊天訊息內容。 |
|
通訊識別碼
|
value.content.participants.communicationIdentifier | CommunicationIdentifier |
通訊識別碼。 |
|
寄件者顯示名稱
|
value.senderDisplayName | string |
聊天訊息寄件者的顯示名稱。 此屬性可用來填入推播通知的寄件者名稱。 |
|
創建日期
|
value.createdOn | string |
聊天訊息到達伺服器時RFC3339格式的時間戳記 (yyyy-MM-ddTHH:mm:ssZ)。 |
|
發送者通訊識別碼
|
value.senderCommunicationIdentifier | CommunicationIdentifier |
通訊識別碼。 |
|
下一個連結
|
nextLink | string |
如果有更多聊天訊息可以擷取,則會填入下一個連結。 |
刪除聊天對話串
刪除聊天討論串。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
取得聊天線程屬性
取得聊天線程的屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
聊天線程 ID。 |
|
主題
|
topic | string |
聊天線程主題。 |
|
創建日期
|
createdOn | string |
建立執行緒的時間。 |
|
刪除日期
|
deletedOn | string |
刪除執行緒的時間。 |
|
原始ID
|
createdByCommunicationIdentifier.rawId | string |
識別碼的原始 ID。 |
|
ID
|
createdByCommunicationIdentifier.communicationUser.id | string |
通訊使用者的 ID。 |
建立聊天對話串
建立聊天線程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
聊天線程主題
|
topic | True | string |
聊天線程主題。 |
|
使用者識別碼
|
id | string | ||
|
名稱
|
displayName | string |
聊天參與者的顯示名稱。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
chatThread.id | string |
聊天線程 ID |
|
主題
|
chatThread.topic | string |
聊天線程主題 |
|
創建日期
|
chatThread.createdOn | date-time |
聊天建立時間 |
|
createdByCommunicationIdentifier
|
chatThread.createdByCommunicationIdentifier | CommunicationIdentifier |
通訊識別碼。 |
新增聊天討論串參與者
將參與者新增至聊天線程。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
使用者識別碼
|
id | string | ||
|
顯示名稱
|
displayName | string |
聊天參與者的顯示名稱。 |
|
|
Time
|
shareHistoryTime | string |
RFC3339格式 (yyyy-MM-ddTHH:mm:ssZ) 的時間,從中共享聊天記錄。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
無效參與者
|
invalidParticipants | array of object |
無效的參與者清單。 |
|
標的
|
invalidParticipants.target | string |
目標識別碼。 |
|
Code
|
invalidParticipants.code | string |
錯誤碼。 |
|
Message
|
invalidParticipants.message | string |
錯誤訊息。 |
更新聊天線程屬性
更新聊天線程的屬性。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
聊天線程主題
|
topic | string |
聊天線程主題。 |
移除聊天討論串參與者
從聊天線程中刪除參與者。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
存取令牌
|
Access-Token | True | string |
使用者存取權杖。 |
|
執行緒識別碼
|
chatThreadId | True | string |
聊天線程 ID。 |
|
使用者識別碼
|
id | string |
定義
通訊識別碼
通訊識別碼。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用者識別碼
|
communicationUser.id | string |