通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Chat Thread - Send Chat Read Receipt

  • 参考
服务:
Communication
API 版本:
2024-03-07

代表用户向线程发送已读回执事件。

POST {endpoint}/chat/threads/{chatThreadId}/readReceipts?api-version=2024-03-07

URI 参数

名称 在 必需 类型 说明
chatThreadId
 path True

string

要向其发送已读回执事件的线程 ID。
endpoint
 path True

string

Azure 通信资源的终结点。
api-version
 query True

string

要调用的 API 版本。

请求头

名称 必需 类型 说明
Authorization True

string

ACS（Azure 通信服务）用户访问令牌。

请求正文

名称 必需 类型 说明
chatMessageId True

string

用户读取的最新聊天消息的 ID。

响应

名称 类型 说明
200 OK

请求成功。
401 Unauthorized

CommunicationErrorResponse

未经 授权。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

请求过多。
Other Status Codes

CommunicationErrorResponse

服务不可用。

安全性

Authorization

ACS（Azure 通信服务）用户访问令牌。

类型: apiKey
在: header

示例

Send read receipt

示例请求

POST https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/readReceipts?api-version=2024-03-07

{
  "chatMessageId": "1591137790240"
}

示例响应

状态代码:
200
状态代码:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
状态代码:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
状态代码:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
状态代码:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定义

SendReadReceiptRequest

请求发送已读回执的有效负载。

名称 类型 说明
chatMessageId

string

用户读取的最新聊天消息的 ID。