管理屏蔽

​

开始使用静音管理端点

本快速入门指南将帮助你使用 Postman 向静音管理端点发出你的第一个请求。

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

先决条件

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

• 注册开发者账号 并获得审核通过。
• 在开发者门户中创建一个 Project 以及关联的 developer App。
• 前往你的应用的“Keys and tokens”页面生成所需的凭证。请确保将所有凭证保存在安全的位置。

​

构建管理“静音”请求的步骤

​

步骤一：从工具或库入手

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

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

将 X API v2 添加到 Postman

在你将 X API v2 集合加载到 Postman 后，前往 “Mutes” 文件夹，并选择 “Mute a user’s ID”。  

​

步骤二：为请求进行认证

要正确向 X API 发起请求，您需要先确认自己具备相应权限。针对该端点，您必须使用 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”的环境，并将这些密钥和令牌填入 “initial value” 和 “current value” 字段（点击环境下拉菜单旁的眼睛图标）中。

如果设置正确，这些变量会自动带入该请求的 authorization 选项卡。  

​

步骤三：指定谁将对谁进行静音

Manage mutes 端点需要两个 ID：一个是用户（希望将其他用户静音或取消静音的用户）的 ID，另一个是目标用户（将被静音或取消静音的用户）的 ID。用户的 ID 必须与进行身份验证的用户 ID 一致，这意味着在为请求进行身份验证时，必须传递与该用户 ID 关联的 Access Tokens。在这种情况下，你可以指定你自己的用户 ID。你可以通过两种方式找到你的 ID：

1. 使用按用户名的 user lookup 端点，传入用户名即可获取 id 字段。
2. 查看你的 Access Token，其中的数字部分就是你的用户 ID。

目标 ID 可以是任何有效的用户 ID。在 Postman 中，进入“Params”选项卡，在 id 路径变量的“Value”列中输入你的 ID。然后进入“Body”选项卡，将你希望静音的用户的 ID 填入 target_user_id 参数的值。请务必不要在任何 ID 的前后包含空格。

Key	Value
id	已通过身份验证的用户 ID
target_user_id	你希望静音的用户 ID

​

步骤四：发起请求并查看响应

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

      { "data": { "muting": true } }

如果你收到 “muting”: true，则表示该 id 已成功将 target_user_id 静音。

要取消对同一用户的静音，你可以使用名为“Unmute a user ID”的请求，该请求位于已在 Postman 中加载的 X API v2 集合的 “Mutes” 文件夹中。source_user_id 应为你的用户 ID，target_user_id 应为要取消静音的用户 ID。你无需在 JSON 正文中提供这些参数，请确保在查询参数中添加所需的 source_user_id 和 target_user_id。

取消静音成功后，你将收到与以下示例类似的响应：

      { "data": { "muting": false } }