|
| 1 | +# Azure Communication Services Chat |
| 2 | +This Chat Connector can manage users in a chat, create chats threads, and send messages in a chat. [API ref for chat](https://docs.microsoft.com/en-us/rest/api/communication/chat/chat), [API ref for chat thread](https://docs.microsoft.com/en-us/rest/api/communication/chat/chat-thread). |
| 3 | + |
| 4 | +## Publisher: Microsoft |
| 5 | + |
| 6 | +## Prerequisites |
| 7 | +You will need the following to proceed: |
| 8 | +* A Microsoft Power Apps or Power Automate plan with custom connector feature |
| 9 | +* An Azure subscription |
| 10 | +* An Azure Communication Services resource |
| 11 | + |
| 12 | +## Supported Operations |
| 13 | +The connector supports the following operations: |
| 14 | + |
| 15 | +### Send Chat |
| 16 | +Send a chat to a specified chat thread given an access token. |
| 17 | + |
| 18 | +### Create Chat |
| 19 | +Create a chat given a chat topic. |
| 20 | + |
| 21 | +### List Chat Threads |
| 22 | +List all chat threads. |
| 23 | + |
| 24 | +### List Thread Messages |
| 25 | +List Messages From Thread. |
| 26 | + |
| 27 | +### Get Thread Properties |
| 28 | +Get the properties of a chat thread. |
| 29 | + |
| 30 | +### Add Participant |
| 31 | +Add a participant to a chat thread. |
| 32 | + |
| 33 | +### Remove Participant |
| 34 | +Remove a participant from a chat thread. |
| 35 | + |
| 36 | +### List Participants |
| 37 | +List participants in a chat thread. |
| 38 | + |
| 39 | +## Obtaining Credentials |
| 40 | + |
| 41 | +1 Set up an Azure Communication Services resource |
| 42 | +- [Quickstart doc](https://review.docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?branch=pr-en-us-192537&tabs=windows&pivots=platform-azp) |
| 43 | + |
| 44 | +2 Connection String Authentication |
| 45 | +- You can create a new connection using an [Azure Communication Services resource endpoint url](https://docs.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?tabs=windows&pivots=platform-azp#access-your-connection-strings-and-service-endpoints). |
| 46 | + |
| 47 | +## Known Issues and Limitations |
| 48 | +Does not support Service principal (Azure AD application) Authentication at this time. |
| 49 | + |
| 50 | +## Deployment Instructions |
| 51 | +Run the following commands and follow the prompts: |
| 52 | +```paconn |
| 53 | +paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --script script.csx --icon icon.png |
| 54 | +``` |
0 commit comments