Dela via

Chat Thread - Send Chat Read Receipt

  • Referens
Tjänst:
Communication
API-version:
2024-03-07

Skickar en läskvittohändelse till en tråd för en användares räkning.

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

URI-parametrar

Name I Obligatorisk Typ Description
chatThreadId
 path True

string

Tråd-ID som läskvittohändelsen ska skickas till.
endpoint
 path True

string

Slutpunkten för Azure Communication-resursen.
api-version
 query True

string

Version av API som ska anropas.

Begärandehuvud

Name Obligatorisk Typ Description
Authorization True

string

En ACS-användaråtkomsttoken (Azure Communication Services).

Begärandetext

Name Obligatorisk Typ Description
chatMessageId True

string

Id för det senaste chattmeddelandet som lästs av användaren.

Svar

Name Typ Description
200 OK

Begäran lyckades.
401 Unauthorized

CommunicationErrorResponse

Obehörig.
403 Forbidden

CommunicationErrorResponse

Förbjuden.
429 Too Many Requests

CommunicationErrorResponse

För många begäranden.
Other Status Codes

CommunicationErrorResponse

Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Send read receipt

Exempelbegäran

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

{
  "chatMessageId": "1591137790240"
}

Exempelsvar

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

Definitioner

SendReadReceiptRequest

Begär nyttolast för att skicka ett läskvitto.

Name Typ Description
chatMessageId

string

Id för det senaste chattmeddelandet som lästs av användaren.