Azure Communication Chat
Anslutningsprogram för att använda Azure Communication Services Chat-funktioner.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | Microsoft |
| URL | https://azure.microsoft.com/services/communication-services |
| E-postmeddelande | acssolutions@microsoft.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Microsoft |
| Webbplats | https://azure.microsoft.com/services/communication-services |
| Sekretesspolicy | https://privacy.microsoft.com |
| Kategorier | Communication |
Azure Communication Services Chat hjälper dig att lägga till textkommunikation i realtid till plattformsoberoende program.
Förutsättningar
Du behöver följande för att fortsätta:
- En Microsoft Power Apps- eller Power Automate-plan med anpassad anslutningsfunktion
- En prenumeration på Azure
- En Azure Communication Services-resurs
Hämta autentiseringsuppgifter
1 Konfigurera en Azure Communication Services-resurs
2 Anslutningssträngsautentisering
- Du kan skapa en ny anslutning med hjälp av en url för Azure Communication Services-resursslutpunkten.
Kom igång med anslutningsappen
När du har konfigurerat en Azure Communication Services-resurs genererar du en användaråtkomsttoken. Använd den här token för anslutningsåtgärderna.
Kända problem och begränsningar
Inga kända problem eller begränsningar just nu.
Vanliga frågor
- Hur genererar jag en åtkomsttoken?
- Du kan använda Azure Communication Services Identity Connector för att generera en ny användaridentitet samt uppdatera åtkomsttoken för en användare. Du kan också göra det manuellt via portalen för testning också.
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| Slutpunkts-URL | securestring | Url för Azure Communication Services-slutpunkt. | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta egenskaper för chatttråd |
Hämta egenskaperna för chatttråden. |
| Lista chatttrådar |
Lista chatttrådar. |
| Lista chatttrådsdeltagare |
Visa en lista över deltagare i chatttråden. |
| Lista chatttrådsmeddelanden |
Visa en lista med meddelanden från chatttråden. |
| Lägga till chatttrådsdeltagare |
Lägg till deltagare i chatttråden. |
| Skapa chatttråd |
Skapa en chatttråd. |
| Skicka meddelande till chatttråd |
Skicka meddelande till chatttråden. |
| Ta bort chatttråd |
Ta bort en chatttråd. |
| Ta bort chatttrådsdeltagare |
Ta bort deltagare från chatttråden. |
| Uppdatera egenskaper för chatttråd |
Uppdatera egenskaperna för chatttråden. |
Hämta egenskaper för chatttråd
Hämta egenskaperna för chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
id | string |
Chatttråds-ID. |
|
Ämne
|
topic | string |
Chatttrådsämne. |
|
Skapad på
|
createdOn | string |
Tid då tråden skapades. |
|
Borttagen på
|
deletedOn | string |
Tid då tråden togs bort. |
|
Rå-ID
|
createdByCommunicationIdentifier.rawId | string |
Raw-ID för identifieraren. |
|
ID-nummer
|
createdByCommunicationIdentifier.communicationUser.id | string |
ID för kommunikationsanvändaren. |
Lista chatttrådar
Lista chatttrådar.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Starttid
|
startTime | string |
Starttid i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) för att hämta chatttrådar. |
|
|
Maximal sidstorlek
|
maxPageSize | integer |
Maximalt antal chatttrådar som returneras per sida. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Chatttrådar
|
value | array of object |
Samling chatttrådar. |
|
ID-nummer
|
value.id | string |
Chatttråds-ID. |
|
Ämne
|
value.topic | string |
Chatttrådsämne. |
|
Senaste meddelande som togs emot på
|
value.lastMessageReceivedOn | string |
Tidsstämpel i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) när det sista meddelandet kom till servern. |
|
Borttagen på
|
value.deletedOn | string |
Tidsstämpel i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) när chatttråden togs bort. |
|
Nästa länk
|
nextLink | string |
Om det finns fler chatttrådar som kan hämtas fylls nästa länk i. |
Lista chatttrådsdeltagare
Visa en lista över deltagare i chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Antal deltagare att hoppa över
|
skip | string |
Hoppar över deltagare upp till en angiven position som svar. |
|
|
Maximalt antal deltagare per sida
|
maxPageSize | string |
Maximalt antal deltagare som ska returneras per sida. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
värde
|
value | array of object |
Chattdeltagare. |
|
communicationIdentifier
|
value.communicationIdentifier | CommunicationIdentifier |
Kommunikationsidentifierare. |
|
Namn
|
value.displayName | string |
Visningsnamn för chattdeltagaren. |
|
Time
|
value.shareHistoryTime | string |
Tid i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) som chatthistoriken delas från. |
|
Nästa länk
|
nextLink | string |
Om det finns fler chattdeltagare som kan hämtas fylls nästa länk i. |
Lista chatttrådsmeddelanden
Visa en lista med meddelanden från chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Starttid
|
startTime | string |
Starttid i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) för att hämta meddelanden. |
|
|
Maximal sidstorlek
|
maxPageSize | string |
Maximalt antal meddelanden som ska returneras per sida. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Meddelandelista
|
value | array of object |
Samling chattmeddelanden. |
|
ID-nummer
|
value.id | string |
ID för chattmeddelandet. Det här ID:t genereras av servern. |
|
Typ
|
value.type | string |
Typ av chattmeddelande. |
|
Utgåva
|
value.version | string |
Version av chattmeddelandet. |
|
Sekvens-ID
|
value.sequenceId | string |
Sekvens av chattmeddelandet i konversationen. |
|
meddelande
|
value.content.message | string |
Chattmeddelandeinnehåll. |
|
initiatorCommunicationIdentifier
|
value.content.initiatorCommunicationIdentifier | CommunicationIdentifier |
Kommunikationsidentifierare. |
|
Ämne
|
value.content.topic | string |
Chattmeddelandeinnehåll för meddelanden av typen topicUpdated. |
|
Deltagare
|
value.content.participants | array of object |
Chattmeddelandeinnehåll för meddelanden av typen deltagareLägg till eller deltagareRemoved. |
|
communicationIdentifier
|
value.content.participants.communicationIdentifier | CommunicationIdentifier |
Kommunikationsidentifierare. |
|
Avsändarens visningsnamn
|
value.senderDisplayName | string |
Visningsnamn för chattmeddelandets avsändare. Den här egenskapen används för att fylla i avsändarens namn för push-meddelanden. |
|
Skapad på
|
value.createdOn | string |
Tidsstämpel i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) när chattmeddelandet kom till servern. |
|
senderCommunicationIdentifier
|
value.senderCommunicationIdentifier | CommunicationIdentifier |
Kommunikationsidentifierare. |
|
Nästa länk
|
nextLink | string |
Om det finns fler chattmeddelanden som kan hämtas fylls nästa länk i. |
Lägga till chatttrådsdeltagare
Lägg till deltagare i chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Användar-ID
|
id | string | ||
|
Visningsnamn
|
displayName | string |
Visningsnamn för chattdeltagaren. |
|
|
Time
|
shareHistoryTime | string |
Tid i RFC3339 format (åååå-MM-ddTHH:mm:ssZ) som chatthistoriken delas från. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
invalidParticipants
|
invalidParticipants | array of object |
Ogiltig deltagarlista. |
|
Target
|
invalidParticipants.target | string |
Mål-ID. |
|
Kod
|
invalidParticipants.code | string |
Felkod. |
|
Message
|
invalidParticipants.message | string |
Felmeddelande. |
Skapa chatttråd
Skapa en chatttråd.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Chatttrådsämne
|
topic | True | string |
Chatttrådsämne. |
|
Användar-ID
|
id | string | ||
|
Namn
|
displayName | string |
Visningsnamn för chattdeltagaren. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID-nummer
|
chatThread.id | string |
Chatttråds-ID |
|
Ämne
|
chatThread.topic | string |
Chatttrådsämne |
|
Skapad på
|
chatThread.createdOn | date-time |
Tid för att skapa chatt |
|
createdByCommunicationIdentifier
|
chatThread.createdByCommunicationIdentifier | CommunicationIdentifier |
Kommunikationsidentifierare. |
Skicka meddelande till chatttråd
Skicka meddelande till chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Content
|
content | True | string |
Meddelandeinnehåll. |
|
Namn
|
senderDisplayName | True | string |
Visningsnamn för meddelandesändaren. |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id-nummer
|
id | string |
Id-nummer |
Ta bort chatttråd
Ta bort en chatttråd.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
Ta bort chatttrådsdeltagare
Ta bort deltagare från chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Användar-ID
|
id | string |
Uppdatera egenskaper för chatttråd
Uppdatera egenskaperna för chatttråden.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Åtkomsttoken
|
Access-Token | True | string |
Användaråtkomsttoken. |
|
Tråd-ID
|
chatThreadId | True | string |
Chatttråds-ID. |
|
Chatttrådsämne
|
topic | string |
Chatttrådsämne. |
Definitioner
CommunicationIdentifier
Kommunikationsidentifierare.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Användar-ID
|
communicationUser.id | string |