静音查找

​

开始使用 mutes lookup 端点

本快速入门指南将帮助你使用 Postman 向 mutes lookup 端点发出首个请求。

如果你想查看不同语言的示例代码，请访问我们的 X API v2 示例代码 GitHub 仓库。

先决条件

要完成本指南，你需要一组用于对请求进行认证的 keys and tokens。你可以按照以下步骤生成这些 keys 和 tokens：

• 注册开发者账号 并通过审批。
• 在开发者门户中创建一个 Project 并在其中创建关联的 开发者应用（App）。
• 前往你的应用（App）的“Keys and tokens”页面以生成所需的凭据。请务必将所有凭据保存在安全位置。

​

构建静音列表查询请求的步骤

​

第一步：选择工具或库

有多种工具、代码示例和库可用于向该端点发起请求，但我们将在此使用 Postman 来简化流程。

要将 X API v2 的 Postman 集合加载到你的环境中，请点击以下按钮：

将 X API v2 添加到 Postman

在 Postman 中加载 X API v2 集合后，前往 “Mutes” 文件夹并选择 “Mutes lookup”。  

​

步骤二：对请求进行认证

要正确向 X API 发起请求，你需要确认自己拥有相应权限。对于此 endpoint，你必须使用 OAuth 1.0a 用户上下文 或 OAuth 2.0 授权码（PKCE） 对请求进行认证。

在本示例中，我们将使用 OAuth 1.0a 用户上下文。

你需要将密钥和令牌——具体包括 API Key、API Secret Key、OAuth 1.0a 用户 Access Token 和 OAuth 1.0a 用户 Access Token Secret——添加到 Postman。你可以在 Postman 右上角选择名为“X API v2”的 environment，并将密钥和令牌填入 “initial value” 和 “current value” fields（点击 environment 下拉菜单旁的眼睛图标）。

如果完成正确，这些变量会自动填充到请求的 authorization 选项卡中。  

​

第三步：指定用户

使用此端点时，你必须指定你的用户 ID 或已认证用户的 ID，才能查看你或该已认证用户已静音的对象。

在 Postman 中，进入 “Params” 选项卡，在该部分底部的 “Path Variables” 下，将已认证用户的 ID 输入到 id 的 “Value” 列中，注意不要在 ID 前后包含任何空格。

在 “Path Variables” 部分上方，你会看到可添加的可选 “Query Params”。在本示例中，我们将选中变量 max_results，并将其值设为 5。

Key	Value	Parameter Type
id	（你的用户 ID）	Path
max_results	5	Query

​

步骤四：确定并指定要检索的字段

如果在步骤三后点击“Send”按钮，您将在响应中收到默认的 user object 字段：id、name 和 username。

如果您希望获取除 id、name 和 username 之外的更多字段，必须在请求中通过 fields 和/或 expansions 参数来明确指定。

在本练习中，我们将从不同对象请求三组额外字段：

1. 主用户对象中的附加 user.created_at 字段。
2. 返回用户所关联的置顶 Post 对象的默认字段：id 和 text。
3. 关联 Post 对象中的附加 tweet.created_at 字段。

在 Postman 中，切换到 “Params” 选项卡，并在 “Query Params” 表中添加以下键值对：

Key	Value	Returned fields
user.fields	created_at	user.created_at
expansions	pinned_tweet_id	tweet.id, tweet.text
tweet.fields	created_at	includes.tweets.created_at

现在，您应当在 “Send” 按钮旁看到一个类似的 URL，其中使用的是您自己的用户 ID，而不是示例 ID 的 URL：

https://api.x.com/2/users/1324848235714736129/muting?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=created_at&max_results=5

​

第五步：发起请求并查看响应

完成所有设置后，点击“Send”按钮，您将收到与下方示例类似的响应：

{
  "data": [
    {
      "username": "TwitterDev",
      "created_at": "2013-12-14T04:35:55.000Z",
      "id": "2244994945",
      "name": "Twitter Dev",
      "pinned_tweet_id": "1430984356139470849"
    }
  ],
  "includes": {
    "tweets": [
      {
        "created_at": "2021-08-26T20:03:51.000Z",
        "id": "1430984356139470849",
        "text": "帮助我们打造更优质的 Twitter 开发者平台!\n \n参与年度开发者调查 >>> https://t.co/9yTbEKlJHH https://t.co/fYIwKPzqua"
      }
    ]
  },
  "meta": {
    "result_count": 1
  }
}

​

第六步：对结果进行分页

你可能会注意到，在响应的底部有一个 meta 对象。如果你收到了一个 next_token，这表示还有下一页结果可获取。要获取下一页，你需要取出 next_token 字段的值，并将其作为额外的 pagination_token 查询参数的值添加到请求中。  

键	值
pagination_token	1710819323648428707

在添加了这个额外参数后发送请求时，由于我们在第三步将 max_results 指定为 5，接下来的五条结果会随后续的响应负载一起返回。你可以持续重复此过程，直到返回所有结果；也可以使用 max_results 参数在每个请求中最多请求 1000 个用户，从而减少分页次数。