Chat Thread - Get Chat Thread Properties

Serviço:

Communication

Versão da API:

2024-03-07

Obtém as propriedades de um thread de chat.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
chatThreadId	path	True	string	ID do thread.
endpoint	path	True	string	O ponto de extremidade do recurso de Comunicação do Azure.
api-version	query	True	string	Versão da API a ser invocada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).

Respostas

Nome	Tipo	Description
200 OK	ChatThreadProperties	Solicitação bem-sucedida. A ação retorna um thread de chat.
401 Unauthorized	CommunicationErrorResponse	Desautorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Muitas solicitações.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Get chat thread

Solicitação de exemplo

HTTP

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

Resposta de exemplo

Código de status:

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"
    }
  }
}

Código de status:

401

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

Código de status:

403

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

Código de status:

429

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

Código de status:

503

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

Definições

ChatThreadProperties

Thread de chat.

Nome	Tipo	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	O carimbo de data/hora quando o thread de chat foi criado. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string	O carimbo de data/hora quando o thread de chat foi excluído. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	ID do thread de chat.
topic	string	Tópico do thread de chat.