导入
列出对话和用户
学习如何使用 Slack API 调用来获取工作区中用户的数据。
让我们来看本课中的以下端点:
users.conversations:此端点列出请求用户可访问的对话。users.list:此端点列出 Slack 团队中的所有用户。
获取对话列表
要获取对话列表,我们将访问 https://slack.com/api/users.conversations 端点。可以使用此端点了解应用程序参与的对话数量。
请求参数
users.conversations 端点的一些重要查询参数如下:
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| token | token | 必需 | 认证令牌携带了控制不同 Slack 应用和 API 使用权限所需的权限范围。我们通常将这些令牌作为 HTTP Authorization 头或 POST 参数传递。 |
| cursor | string | 可选 | 此参数是一串字符,用于“指向”下一页数据。通过将 cursor 参数设置为前一次请求 response_metadata 中返回的 next_cursor 属性,实现对数据集合的分页。 |
| limit | string | 可选 | 返回的最大项目数量。 |
让我们调用 users.conversations 端点。点击“运行”按钮,以获取应用程序可访问的对话列表。
1import fetch from "node-fetch"; 2 3const url = new URL("https://slack.com/api/users.conversations"); 4 5const headerParameters = { 6 Authorization: "Bearer {{TOKEN}}", 7 "Content-Type": "application/x-www-form-urlencoded", 8}; 9 10const options = { 11 method: "GET", 12 headers: headerParameters, 13}; 14 15async function getConversations() { 16 try { 17 const response = await fetch(url, options); 18 printResponse(response); 19 } catch (error) { 20 printError(error); 21 } 22} 23 24getConversations();
在 第 17 行,我们调用 users.conversations 端点,获取应用程序(或授权用户)参与的对话。
响应字段
响应中包含应用程序可以参与的 channels 列表。
注意:查看本课程以了解
channels属性中每个元素的详细信息。
获取用户列表
要获取用户列表,我们访问 https://slack.com/api/users.list 端点。API 将返回指定工作区中的用户列表。
请求参数
users.list 端点的一些重要查询参数如下:
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| token | token | 必需 | 认证令牌携带了控制不同 Slack 应用和 API 使用权限所需的权限范围。我们通常将这些令牌作为 HTTP Authorization 头或 POST 参数传递。 |
| cursor | string | 可选 | 此参数是一串字符,用于“指向”下一页数据。通过将 cursor 参数设置为前一次请求 response_metadata 中返回的 next_cursor 属性,实现对数据集合的分页。 |
| limit | string | 可选 | 返回的最大项目数量。 |
让我们调用 users.list 端点。点击“运行”按钮,以获取工作区中的用户列表作为响应。
1import fetch from "node-fetch"; 2 3const url = new URL("https://slack.com/api/users.list"); 4 5const headerParameters = { 6 Authorization: "Bearer {{TOKEN}}", 7 "Content-Type": "application/x-www-form-urlencoded", 8}; 9 10const options = { 11 method: "GET", 12 headers: headerParameters, 13}; 14 15async function getUsers() { 16 try { 17 const response = await fetch(url, options); 18 printResponse(response); 19 } catch (error) { 20 printError(error); 21 } 22} 23 24getUsers();
在 第 17 行,我们调用 users.list 端点,获取工作区中存在或曾经存在的用户列表。
响应字段
响应包含工作区中所有 members 的列表。
注意:查看本课程以了解
members属性中每个元素的详细信息。