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

Chat - List Chat Threads

获取用户的聊天线程列表。

GET {endpoint}/chat/threads?api-version=2021-09-07
GET {endpoint}/chat/threads?maxPageSize={maxPageSize}&startTime={startTime}&api-version=2021-09-07

URI 参数

Name In Required Type Description
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

请求头

Name Required Type Description
Authorization True
  • string

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

响应

Name Type Description
200 OK

请求成功。 该操作返回资源 GetThreadsResponse

401 Unauthorized
  • CommunicationErrorResponse

未授权。

403 Forbidden
  • CommunicationErrorResponse

已禁止。

Other Status Codes
  • CommunicationErrorResponse

请求过多。

Other Status Codes
  • CommunicationErrorResponse

服务不可用。

安全性

Authorization

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

Type: apiKey
In: header

示例

Get threads with pagination (Max Page Size)

Sample Request

GET https://contoso.westus.communications.azure.com/chat/threads?maxPageSize=5&api-version=2021-09-07

Sample Response

{
  "value": [
    {
      "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
      "topic": "Chat with Samantha",
      "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z"
    },
    {
      "id": "19:a0dfe5fc10e04a7f8d8a64d455f4196d@thread.v2",
      "topic": "Presentation Brainstorming",
      "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z"
    },
    {
      "id": "19:uni01_n242d2bzammtwxiib7pbjtozeevjqzavzn654ku3dajocexfo2na@thread.v2",
      "topic": "Chat with Alex",
      "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z"
    },
    {
      "id": "19:0062022a28be4e0983734f7e45cd8566@thread.v2",
      "topic": "Lunch",
      "deletedOn": "2020-07-07T05:55:41.6460000Z",
      "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z"
    },
    {
      "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpe@thread.v2",
      "topic": "Chat with Bob",
      "lastMessageReceivedOn": "2020-06-06T05:55:41.6460000Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads?syncState=W3sic3RhcnQiOiIyMDIwLTA2LTIzVDIzOjMyOjQ3LjMwNSswMDowMCIsImVuZCI6IjIwMjAtMDYtMjVUMDY6NTY6MjMuNjk2KzAwOjAwIn0seyJzdGFydCI6IjE5NzAtMDEtMDFUMDA6MDA6MDArMDA6MDAiLCJlbmQiOiIxOTcwLTAxLTAxVDAwOjAwOjAwKzAwOjAwIn1d&api-version=2021-09-07&maxPageSize=5"
}
{
  "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."
  }
}

定义

ChatThreadItem

聊天线程的摘要信息。

ChatThreadsItemCollection

聊天线程的集合。

ChatThreadItem

聊天线程的摘要信息。

Name Type Description
deletedOn
  • string

删除聊天线程时的时间戳。 时间戳采用 RFC3339 格式: yyyy-MM-ddTHH:mm:ssZ

id
  • string

聊天线程 ID。

lastMessageReceivedOn
  • string

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

topic
  • string

聊天线程主题。

ChatThreadsItemCollection

聊天线程的集合。

Name Type Description
nextLink
  • string

如果可以检索更多的聊天线程,将填充下一个链接。

value

聊天线程的集合。