当前位置:首页 > 行业动态 > 正文

钉钉如何通过API获取圈子信息?

要通过API获取钉钉圈子信息,你需要遵循以下步骤:

1、获取Access Token

2、调用获取圈子信息的API

3、处理返回的圈子信息

以下是详细的步骤和代码示例:

获取Access Token

1、登录钉钉开放平台(https://opendev.dingtalk.com/),创建一个应用。

2、在应用详情页,找到“应用Key”和“应用Secret”,这两个参数将用于后续的API调用。

3、使用以下Python代码获取Access Token:

import requests
app_key = "your_app_key"
app_secret = "your_app_secret"
url = f"https://oapi.dingtalk.com/gettoken?appkey={app_key}&appsecret={app_secret}"
response = requests.get(url)
access_token = response.json()["access_token"] 

调用获取圈子信息的API

1、使用以下Python代码调用获取圈子信息的API:

import requests
access_token = "your_access_token"
url = f"https://oapi.dingtalk.com/topapi/circle/listbypage?access_token={access_token}"
headers = {"ContentType": "application/json;charset=utf8"}
response = requests.post(url, json={}, headers=headers)
data = response.json() 

2、API参数说明:

参数名 类型 是否必须 描述
access_token string 访问令牌
agent_id int 应用ID,默认为0
offset int 分页查询的偏移量,默认为0
size int 分页查询的每页数据量,默认为30
keyword string 圈子名称关键字,支持模糊查询
order_by string 圈子排序方式,可选值为 “create_time”, “update_time”, “activity_time”, “hot”, “latest”, “oldest”, “alphabet”, “hot”, “latest”, “oldest”, “alphabet”,默认为 “latest”
fields string 需要返回的字段,多个字段用逗号分隔,默认为 “id,name,owner,members,intro,cover_photo,create_time,update_time,activity_time,is_public,is_union,is_verified,is_maintained,is_closed,is_hidden,is_maximized,is_displayed,is_notice,is_allow_join,is_allow_invite,is_allow_post,is_allow_vote,is_allow_recommend,is_allow_comment,is_allow_attention,is_allow_mention,is_allow_transfer,is_allow_delete,is_allow_edit,is_allow_hide,is_allow_banner,is_allow_tag”
is_searchall bool 是否搜索全部圈子,默认为false
is_searchorg bool 是否搜索到根组织,默认为false
is_searchdept bool 是否搜索到部门,默认为false
is_searchteam bool 是否搜索到团队,默认为false
is_searchuser bool 是否搜索到个人,默认为false
is_searchparty bool 是否搜索到群组,默认为false
is_searchchatroom bool 是否搜索到聊天室,默认为false
is_searchdiscussions bool 是否搜索到讨论组,默认为false
is_searchofflinemessages bool 是否搜索到离线消息,默认为false
is_searchcontacts bool 是否搜索到联系人,默认为false
is_searchcalendarevents bool 是否搜索到日程事件,默认为false
is_searchmeetingrooms bool 是否搜索到会议室,默认为false
is_searchcontracts bool 是否搜索到合同,默认为false
is_searchagreements bool 是否搜索到协议,默认为false
is_searchactivities bool 是否搜索到活动,默认为false
is_searchfilesharingrecords bool 是否搜索到文件共享记录,默认为false
is_searchrecordresults bool 是否搜索到记录结果,默认为false
is_searchreportstemplates bool 是否搜索到报表模板,默认为false
is_searchreportsdatasources bool 是否搜索到报表数据源,默认为false
is_searchreportsschedules bool 是否搜索到报表计划,默认为false
is_searchreportsinstances bool 是否搜索到报表实例,默认为false

| is_searchreportsoutputsinks | bool || false

0