Поделиться через

Chat Thread - Get Chat Message

Служба:
Communication
Версия API:
2025-03-15

Возвращает сообщение по идентификатору.

GET {endpoint}/chat/threads/{chatThreadId}/messages/{chatMessageId}?api-version=2025-03-15

Параметры URI

Имя В Обязательно Тип Описание
chatMessageId
 path True

string

Идентификатор сообщения.
chatThreadId
 path True

string

Идентификатор потока, в который отправлено сообщение.
endpoint
 path True

string

Конечная точка ресурса связи Azure.
api-version
 query True

string

Версия API для вызова.

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

Имя Обязательно Тип Описание
Authorization True

string

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

Ответы

Имя Тип Описание
200 OK

ChatMessage

Запрос успешно выполнен. Действие возвращает ресурс Message.
401 Unauthorized

CommunicationErrorResponse

Нет разрешения.
403 Forbidden

CommunicationErrorResponse

Запретный.
429 Too Many Requests

CommunicationErrorResponse

Слишком много запросов.
Other Status Codes

CommunicationErrorResponse

Служба недоступна.

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

Authorization

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

Тип: apiKey
В: header

Примеры

Get Message

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

GET https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1591768249318?api-version=2025-03-15

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

Код состояния:
200 
{
  "id": "1591768249318",
  "sequenceId": "1",
  "type": "text",
  "version": "1599016601134",
  "content": {
    "message": "Let's head out for lunch in 15 minutes."
  },
  "senderDisplayName": "Jane",
  "createdOn": "2020-06-10T05:50:49.3180000Z",
  "senderCommunicationIdentifier": {
    "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"
    }
  },
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}
Код состояния:
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."
  }
}

Определения

Имя Описание
ChatAttachment

Вложение в сообщении чата.
ChatAttachmentType

Тип вложения.
ChatMessage

Сообщение чата.
ChatMessageContent

Содержимое сообщения чата.
ChatMessageType

Тип сообщения чата.
ChatParticipant

Участник потока чата.

ChatAttachment

Object

Вложение в сообщении чата.

Имя Тип Описание
attachmentType

ChatAttachmentType

Тип вложения.
id

string

Идентификатор вложения
name

string

Имя содержимого вложения.
previewUrl

string (uri)

URL-адрес, в котором можно скачать предварительное представление вложения
url

string (uri)

URL-адрес, в котором можно скачать вложение

ChatAttachmentType

Перечисление

Тип вложения.

Значение Описание
image
file

ChatMessage

Object

Сообщение чата.

Имя Тип Описание
content

ChatMessageContent

Содержимое сообщения чата.
createdOn

string (date-time)

Метка времени, когда сообщение чата прибыло на сервер. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn

string (date-time)

Метка времени (если применимо) при удалении сообщения. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.
editedOn

string (date-time)

Последняя метка времени (если применимо) при изменении сообщения. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id

string

Идентификатор сообщения чата. Этот идентификатор создается на сервере.
metadata

object

Метаданные сообщения.
senderCommunicationIdentifier

CommunicationIdentifierModel

senderDisplayName

string

Отображаемое имя отправителя сообщения чата. Это свойство используется для заполнения имени отправителя для push-уведомлений.
sequenceId

string

Последовательность сообщения чата в беседе.
type

ChatMessageType

Тип сообщения чата.
version

string

Версия сообщения чата.

ChatMessageContent

Object

Содержимое сообщения чата.

Имя Тип Описание
attachments

ChatAttachment[]

Список вложений для этого сообщения
initiatorCommunicationIdentifier

CommunicationIdentifierModel

message

string

Содержимое сообщения чата для сообщений типов текста или html.
participants

ChatParticipant[]

Содержимое сообщения чата для сообщений типа участникаAdded или участника Удалено.
topic

string

Содержимое сообщения чата для сообщений типа topicUpdated.

ChatMessageType

Перечисление

Тип сообщения чата.

Значение Описание
text
html
topicUpdated
participantAdded
participantRemoved

ChatParticipant

Object

Участник потока чата.

Имя Тип Описание
communicationIdentifier

CommunicationIdentifierModel

displayName

string

Отображаемое имя участника чата.
metadata

object

Контекстные метаданные для участника чата. Метаданные состоят из пар name/value. Общий размер всех пар метаданных может составлять до 1 КБ.
shareHistoryTime

string (date-time)

Время, из которого журнал чата предоставляется участнику. Метка времени находится в формате RFC3339: yyyy-MM-ddTHH:mm:ssZ.