Chat Thread - Get Chat Thread Properties

Служба:

Communication

Версия API:

2024-03-07

Возвращает свойства потока чата.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
chatThreadId	path	True	string	Идентификатор потока.
endpoint	path	True	string	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей ACS (Службы коммуникации Azure).

Ответы

Имя	Тип	Описание
200 OK	ChatThreadProperties	Запрос успешно выполнен. Действие возвращает поток чата.
401 Unauthorized	CommunicationErrorResponse	Несанкционированный.
403 Forbidden	CommunicationErrorResponse	Запретный.
429 Too Many Requests	CommunicationErrorResponse	Слишком много запросов.
Other Status Codes	CommunicationErrorResponse	Служба недоступна.

Безопасность

Authorization

Маркер доступа пользователей ACS (Службы коммуникации Azure).

Тип: apiKey
В: header

Примеры

Get chat thread

Образец запроса

HTTP

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

Пример ответа

Код состояния:

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

Код состояния:

401

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

Код состояния:

403

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

Код состояния:

429

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

Код состояния:

503

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

Определения

ChatThreadProperties

Поток чата.

Имя	Тип	Описание
createdByCommunicationIdentifier	CommunicationIdentifierModel
createdOn	string	Метка времени создания потока чата. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn	string	Метка времени удаления потока чата. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id	string	Идентификатор потока чата.
topic	string	Раздел потока чата.