你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Chat Thread - List Chat Messages

获取来自线程的消息列表。

GET {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2024-03-15-preview
GET {endpoint}/chat/threads/{chatThreadId}/messages?maxPageSize={maxPageSize}&startTime={startTime}&api-version=2024-03-15-preview

URI 参数

名称 必需 类型 说明
chatThreadId
path True

string

消息的线程 ID。

endpoint
path True

string

Azure 通信资源的终结点。

api-version
query True

string

要调用的 API 的版本。

maxPageSize
query

integer

int32

每页返回的最大消息数。

startTime
query

string

date-time

要获取消息的最早时间点。 时间戳应采用RFC3339格式: yyyy-MM-ddTHH:mm:ssZ

请求头

名称 必需 类型 说明
Authorization True

string

ACS (Azure 通信服务) 用户访问令牌。

响应

名称 类型 说明
200 OK

ChatMessagesCollection

成功

401 Unauthorized

CommunicationErrorResponse

未授权。

403 Forbidden

CommunicationErrorResponse

已禁止。

429 Too Many Requests

CommunicationErrorResponse

请求过多。

Other Status Codes

CommunicationErrorResponse

服务不可用。

安全性

Authorization

ACS (Azure 通信服务) 用户访问令牌。

类型: apiKey
在: header

示例

Get messages with pagination (max page size)

示例请求

GET https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?maxPageSize=5&api-version=2024-03-15-preview

示例响应

{
  "value": [
    {
      "id": "1593107077690",
      "type": "html",
      "version": "1593107077683",
      "sequenceId": "5",
      "content": {
        "message": "<p>This place for lunch?&nbsp;</p>\r\n<p><img itemscope=\"png\" src=\"\" width=\"1425\" height=\"539\" alt=\"image\" id=\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"></p>",
        "attachments": [
          {
            "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73",
            "attachmentType": "image",
            "name": "image",
            "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview",
            "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview"
          }
        ]
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "metadata": {
        "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]"
      },
      "senderCommunicationIdentifier": {
        "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
        "communicationUser": {
          "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
        }
      }
    },
    {
      "id": "1593107077683",
      "type": "text",
      "sequenceId": "4",
      "version": "1593107077683",
      "content": {
        "message": "Let's use this chat to decide what to get for lunch today."
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "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"
        }
      }
    },
    {
      "id": "1593107046498",
      "type": "text",
      "sequenceId": "3",
      "version": "1593107046498",
      "content": {
        "message": "Good morning everyone!"
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:06.4980000Z",
      "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"
        }
      }
    },
    {
      "id": "1593106976785",
      "type": "topicUpdated",
      "sequenceId": "2",
      "version": "1593106976785",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "topic": "Lunch"
      },
      "createdOn": "2020-06-25T17:42:56.7850000Z"
    },
    {
      "id": "1593106976753",
      "type": "participantAdded",
      "version": "1593106976753",
      "sequenceId": "1",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "participants": [
          {
            "communicationIdentifier": {
              "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"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
              }
            }
          }
        ]
      },
      "createdOn": "2020-06-25T17:42:56.7530000Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2024-03-15-preview"
}
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定义

名称 说明
ChatAttachment

聊天消息中的附件。 目前仅在 Teams 互操作方案中受支持。

ChatAttachmentType

附件的类型。

ChatMessage

聊天消息。

ChatMessageContent

聊天消息的内容。

ChatMessagesCollection

特定聊天线程的聊天消息集合。

ChatMessageType

聊天消息类型。

ChatParticipant

聊天线程的参与者。

ChatAttachment

聊天消息中的附件。 目前仅在 Teams 互操作方案中受支持。

名称 类型 说明
attachmentType

ChatAttachmentType

附件的类型。

id

string

附件的 ID

name

string

附件内容的名称。

previewUrl

string

可在其中下载附件预览的 URL

url

string

可以下载附件的 URL

ChatAttachmentType

附件的类型。

名称 类型 说明
file

string

image

string

ChatMessage

聊天消息。

名称 类型 说明
content

ChatMessageContent

聊天消息的内容。

createdOn

string

聊天消息到达服务器的时间戳。 时间戳采用RFC3339格式: yyyy-MM-ddTHH:mm:ssZ

deletedOn

string

如果适用,) 删除消息时时间戳 (。 时间戳采用RFC3339格式: yyyy-MM-ddTHH:mm:ssZ

editedOn

string

编辑消息时) 最后一个时间戳 ((如果适用)。 时间戳采用RFC3339格式: yyyy-MM-ddTHH:mm:ssZ

id

string

聊天消息的 ID。 此 ID 是服务器生成的。

metadata

object

消息元数据。

senderCommunicationIdentifier

CommunicationIdentifierModel

senderDisplayName

string

聊天消息发件人的显示名称。 此属性用于填充推送通知的发件人名称。

sequenceId

string

聊天中聊天消息的顺序。

type

ChatMessageType

聊天消息类型。

version

string

聊天消息的版本。

ChatMessageContent

聊天消息的内容。

名称 类型 说明
attachments

ChatAttachment[]

此邮件的附件列表

initiatorCommunicationIdentifier

CommunicationIdentifierModel

message

string

文本或 html 类型的消息的聊天消息内容。

participants

ChatParticipant[]

参与者Added或 participantRemoved 类型的消息的聊天消息内容。

topic

string

topicUpdated 类型的消息的聊天消息内容。

ChatMessagesCollection

特定聊天线程的聊天消息集合。

名称 类型 说明
nextLink

string

如果有更多可检索的聊天消息,则会填充下一个链接。

value

ChatMessage[]

聊天消息的集合。

ChatMessageType

聊天消息类型。

名称 类型 说明
html

string

participantAdded

string

participantRemoved

string

text

string

topicUpdated

string

ChatParticipant

聊天线程的参与者。

名称 类型 说明
communicationIdentifier

CommunicationIdentifierModel

displayName

string

聊天参与者的显示名称。

metadata

object

聊天参与者的上下文元数据。 元数据由名称/值对组成。 所有元数据对的总大小最大为 1KB。

shareHistoryTime

string

与参与者共享聊天历史记录的时间。 时间戳采用RFC3339格式: yyyy-MM-ddTHH:mm:ssZ