Azure Communication Services: Communicationserviceschat
Azure Communication Chat Service
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Azure Communication Chat Service
Endpoints 16
Threads
- GETGets chat message read receipts for a thread.
/chat/threads/:chatThreadId/readReceipts?maxPageSize=0&skip=0&api-version=string - POSTSends a read receipt event to a thread, on behalf of a user.
/chat/threads/:chatThreadId/readReceipts?api-version=string - GETGets the list of chat threads of a user.
/chat/threads?maxPageSize=0&startTime=2024-01-01T00:00:00Z&api-version=string - POSTCreates a chat thread.
/chat/threads?api-version=string - GETGets a chat thread's properties.
/chat/threads/:chatThreadId?api-version=string - DELETEDeletes a thread.
/chat/threads/:chatThreadId?api-version=string - PATCHUpdates a thread's properties.
/chat/threads/:chatThreadId?api-version=string
Messages
- GETGets a list of messages from a thread.
/chat/threads/:chatThreadId/messages?maxPageSize=0&startTime=2024-01-01T00:00:00Z&api-version=string - POSTSends a message to a thread.
/chat/threads/:chatThreadId/messages?api-version=string - GETGets a message by id.
/chat/threads/:chatThreadId/messages/:chatMessageId?api-version=string - DELETEDeletes a message.
/chat/threads/:chatThreadId/messages/:chatMessageId?api-version=string - PATCHUpdates a message.
/chat/threads/:chatThreadId/messages/:chatMessageId?api-version=string
Participants
- GETGets the participants of a thread.
/chat/threads/:chatThreadId/participants?maxPageSize=0&skip=0&api-version=string - POSTRemove a participant from a thread.
/chat/threads/:chatThreadId/participants/:remove?api-version=string - POSTAdds thread participants to a thread. If participants already exist, no change occurs.
/chat/threads/:chatThreadId/participants/:add?api-version=string
TypingNotifications
- POSTPosts a typing event to a thread, on behalf of a user.
/chat/threads/:chatThreadId/typing?api-version=string
API details
- Authentication
- An API key in the Authorization header
- Operations
- 16 operations on 9 pathsGET 6POST 6PATCH 2DELETE 2
- Main resources
- Threads 7Messages 5Participants 3TypingNotifications 1
- Description format
- Swagger 2.0, API version
2025-03-15 - Links
- OpenAPI document
How to test the Azure Communication Services: Communicationserviceschat in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Communication Services: Communicationserviceschat collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets chat message read receipts for a thread.” (GET /chat/threads/:chatThreadId/readReceipts?maxPageSize=0&skip=0&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Communication Services: Communicationserviceschat?
Azure Communication Chat Service It is listed under Communication and has 16 endpoints.
Who publishes the Azure Communication Services: Communicationserviceschat?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Communication Services: Communicationserviceschat?
With an API key in the Authorization header.
How many endpoints does the Azure Communication Services: Communicationserviceschat have?
16 operations on 9 paths (6 GET, 6 POST, 2 PATCH, 2 DELETE). The largest groups are Threads, Messages, Participants, TypingNotifications.
Is forking the Azure Communication Services: Communicationserviceschat free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.