Compartir a través de

Chat Thread - Send Chat Read Receipt

  • Referencia
Servicio:
Communication
Versión de la API:
2024-03-07

Envía un evento de recepción de lectura a un subproceso, en nombre de un usuario.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
chatThreadId
 path True

string

Identificador de subproceso al que se va a enviar el evento de recepción de lectura.
endpoint
 path True

string

Punto de conexión del recurso de Comunicación de Azure.
api-version
 query True

string

Versión de la API que se va a invocar.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Authorization True

string

Un token de acceso de usuario de ACS (Azure Communication Services).

Cuerpo de la solicitud

Nombre Requerido Tipo Description
chatMessageId True

string

Identificador del mensaje de chat más reciente leído por el usuario.

Respuestas

Nombre Tipo Description
200 OK

Solicitud correcta.
401 Unauthorized

CommunicationErrorResponse

Desautorizado.
403 Forbidden

CommunicationErrorResponse

Prohibido.
429 Too Many Requests

CommunicationErrorResponse

Demasiadas solicitudes.
Other Status Codes

CommunicationErrorResponse

Servicio no disponible.

Seguridad

Authorization

Un token de acceso de usuario de ACS (Azure Communication Services).

Tipo: apiKey
En: header

Ejemplos

Send read receipt

Solicitud de ejemplo

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

{
  "chatMessageId": "1591137790240"
}

Respuesta de muestra

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

Definiciones

SendReadReceiptRequest

Solicitar carga para enviar una confirmación de lectura.

Nombre Tipo Description
chatMessageId

string

Identificador del mensaje de chat más reciente leído por el usuario.