Chat Thread - Get Chat Thread Properties

Servicio:

Communication

Versión de la API:

2024-03-07

Obtiene las propiedades de un subproceso de chat.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
chatThreadId	path	True	string	Identificador del subproceso.
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).

Respuestas

Nombre	Tipo	Description
200 OK	ChatThreadProperties	Solicitud correcta. La acción devuelve un subproceso de chat.
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

Get chat thread

Solicitud de ejemplo

HTTP

GET https://contoso.westus.communications.azure.com/chat/threads/19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2?api-version=2024-03-07

Respuesta de muestra

status code:

200

{
  "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
  "topic": "Lunch",
  "createdOn": "2020-06-06T05:55:41.6460000Z",
  "createdByCommunicationIdentifier": {
    "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"
    }
  }
}

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

ChatThreadProperties

Subproceso de chat.

Nombre	Tipo	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Marca de tiempo cuando se creó el subproceso de chat. La marca de tiempo está en formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string	Marca de tiempo cuando se eliminó el subproceso de chat. La marca de tiempo está en formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	Identificador de subproceso de chat.
topic	string	Tema del subproceso de chat.