简介

账户设置

若要访问这些 endpoint，您需要：

• 已获批准的 开发者账户。
• 使用位于某个 Project 中的 开发者 App 提供的密钥和令牌进行认证。 

在我们的 入门指南 中了解如何获取对 X API v2 endpoint 的访问权限。

开始使用

​

身份验证

你可以使用 OAuth 1.0a 用户上下文、OAuth 2.0 App-Only 或 OAuth 2.0 授权码模式（Authorization Code）配合 PKCE 对该 endpoint 进行身份验证。  

​

发起请求

你可以按如下示例，通过提供一个 id 来调用 Communities Lookup endpoint（使用 id 1758747817642700922）：

      curl --location 'https://api.x.com/2/communities/1758747817642700922' --header 'Authorization: ••••••'

如果请求成功，您将看到如下所示的 JSON 响应：

{
    "data": {
        "access": "公开",
        "description": "欢迎来到动漫社区！这里是动漫爱好者聚集的地方，大家可以分享喜爱的作品，讨论一切与动漫相关的话题。",
        "join_policy": "开放",
        "name": "动漫社区"
    }
}

​

社群字段

通过指定 Community Fields，您可以获取与某个社群关联的其他 data。

可用的 Community Fields 如下：

字段值	类型	说明
created_at	date (ISO 8601)	社群的创建时间。
id	string	社群的唯一标识符。
name	string	社群名称。
description	string	社群的描述文本（如有）。
access	string	社群的访问级别。 可能为以下之一： * Public * Closed
join_policy	string	社群的加入策略。 可能为以下之一： * Open * RestrictedJoinRequestsDisabled * RestrictedJoinRequestsRequireAdminApproval * RestrictedJoinRequestsRequireModeratorApproval * SuperFollowRequired
member_count	integer	已加入该社群的成员数量。

​

示例请求

您可以按如下方式调用 Communities Lookup endpoint，并包含额外的社区 fields（使用 id 1758747817642700922）：

curl --location 'https://api.x.com/2/communities/1758747817642700922?community.fields=access,created_at,description,id,join_policy,member_count,name' --header 'Authorization: ••••••'

示例响应

如果请求成功，您将看到如下所示的 JSON 响应：

{
    "data": {
        "description": "欢迎来到动漫社区！动漫爱好者聚集在这里分享他们最喜爱的作品，讨论一切与动漫相关的内容。",
        "access": "公开",
        "member_count": 40369,
        "created_at": "2024-02-17T06:58:50.000Z",
        "join_policy": "开放",
        "name": "动漫社区",
        "id": "Q29tbXVuaXR5OjE3NTg3NDc4MTc2NDI3MDA5MjI="
    }
}