Chat Thread - Send Chat Read Receipt

Referenz

Dienst:: Communication

API-Version:: 2024-03-07

Sendet ein Lesebestätigungsereignis im Auftrag eines Benutzers an einen Thread.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	Thread-ID zum Senden des Lesebestätigungsereignisses an.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
chatMessageId	True	string	ID der neuesten Chatnachricht, die vom Benutzer gelesen wurde.

Antworten

Name	Typ	Beschreibung
200 OK		Anforderung erfolgreich.
401 Unauthorized	CommunicationErrorResponse	Unbefugt.
403 Forbidden	CommunicationErrorResponse	Verboten.
429 Too Many Requests	CommunicationErrorResponse	Zu viele Anforderungen.
Other Status Codes	CommunicationErrorResponse	Der Dienst ist nicht verfügbar.

Sicherheit

Authorization

Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

Send read receipt

Beispielanforderung

HTTP

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

{
  "chatMessageId": "1591137790240"
}

Beispiel für eine Antwort

Statuscode:: 200

Statuscode:: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Statuscode:: 403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Statuscode:: 429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Statuscode:: 503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definitionen

SendReadReceiptRequest

Fordern Sie nutzlast zum Senden einer Lesebestätigung an.

Name	Typ	Beschreibung
chatMessageId	string	ID der neuesten Chatnachricht, die vom Benutzer gelesen wurde.

Freigeben über