你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Chat Thread - Remove Chat Participant
从线程中删除参与者。
POST {endpoint}/chat/threads/{chatThreadId}/participants/:remove?api-version=2024-03-07
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
chat
|
path | True |
string |
要从中删除参与者的线程 ID。 |
endpoint
|
path | True |
string |
Azure 通信资源的终结点。 |
api-version
|
query | True |
string |
要调用的 API 版本。 |
请求头
Media Types: "application/json", "application/merge-patch+json"
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Authorization | True |
string |
ACS(Azure 通信服务)用户访问令牌。 |
请求正文
Media Types: "application/json", "application/merge-patch+json"
名称 | 类型 | 说明 |
---|---|---|
participantCommunicationIdentifier |
Communication |
要从线程中删除的线程参与者的 ID。 |
响应
名称 | 类型 | 说明 |
---|---|---|
204 No Content |
请求成功。 |
|
401 Unauthorized |
Communication |
未经 授权。 |
403 Forbidden |
Communication |
禁止。 |
429 Too Many Requests |
Communication |
请求过多。 |
Other Status Codes |
Communication |
服务不可用。 |
安全性
Authorization
ACS(Azure 通信服务)用户访问令牌。
类型:
apiKey
在:
header
示例
Remove participant
示例请求
POST https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants/:remove?api-version=2024-03-07
{
"rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
"communicationUser": {
"id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
}
}
示例响应
{
"error": {
"code": "Unauthorized",
"message": "Request is not authorized."
}
}
{
"error": {
"code": "Forbidden",
"message": "User is not allowed to perform specified action."
}
}
{
"error": {
"code": "TooManyRequests",
"message": "Rate limit exceeded."
}
}
{
"error": {
"code": "ServiceUnavailable",
"message": "The server is currently unable to handle the request."
}
}