设置禁止群成员私聊

调用本接口设置群成员之间是否可以添加好友和私聊。

本接口适用于企业内部群需要管控成员交流范围、保护信息安全等场景，具体设置如下图所示：image

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

是

钉钉群基础信息管理权限

调试

第三方企业应用

否

—

—

第三方个人应用

否

—

—

基本信息

请求方式：POST

请求地址：https://oapi.dingtalk.com/topapi/chat/member/friendswitch/update

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

是

6d1bxxxx

调用该接口的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

chatid

String

是

chatdafe234xxxx

企业会话ID。可以通过以下方式获取。

is_prohibit

Boolean

是

true

是否开启禁止开关。

  • true：开启禁止开关

  • false：关闭禁止开关

返回参数

名称

类型

示例值

描述

success

Boolean

true

是否设置成功。

  • true：成功

  • false：失败

errcode

Number

0

返回码。

errmsg

String

ok

返回码描述。

request_id

String

10c0wc48i6qzz

请求ID。

示例

请求示例（HTTP）

POST https://oapi.dingtalk.com/topapi/chat/member/friendswitch/update?access_token=ACCESS_TOKEN

请求正文

{
        "chatid":"chatdafe234xxxx",
        "is_prohibit":"true"
}

请求示例（JAVA SDK）

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/chat/member/friendswitch/update");
OapiChatMemberFriendswitchUpdateRequest req = new OapiChatMemberFriendswitchUpdateRequest();
req.setChatid("chatdafe234xxxx");
req.setIsProhibit(true);
OapiChatMemberFriendswitchUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

返回示例

{
    "success":true,
    "errcode":0,
    "errmsg":"ok",
    "request_id":"10c0wc48i6qzz"
}

错误码

错误码（errorcode）

错误码描述（errmsg）

解决方案

34001

无效的chatid

请检查chatid是否符合要求

40036

参数为空

请确认必填参数是否都已经填入

400001

系统错误

请稍后重试