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 do URI

Name	Em	Necessário	Tipo	Description
chatThreadId	path	True	string	Id do tópico.
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 invocar.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	ChatThreadProperties	Pedido bem-sucedido. A ação retorna um thread de bate-papo.
401 Unauthorized	CommunicationErrorResponse	Não autorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Demasiados pedidos.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

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

Tipo: apiKey
Em: header

Exemplos

Get chat thread

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:

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 estado:

401

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

Código de estado:

403

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

Código de estado:

429

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

Código de estado:

503

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

Definições

ChatThreadProperties

Tópico de bate-papo.

Name	Tipo	Description
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	O carimbo de data/hora quando o thread de bate-papo 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 bate-papo foi excluído. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	ID do tópico de chat.
topic	string	Tópico do tópico do bate-papo.