设置禁止群成员私聊

POST

http://127.0.0.1/topapi/chat/member/friendswitch/update

服务端API/群会话管理

最后修改时间：2022-08-30 09:19:21

责任人：未设置

说明

调用本接口设置群成员之间是否可以添加好友和私聊。
服务地址：https://oapi.dingtalk.com

权限

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

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

chatid

string

必需

企业会话ID。可以通过以下方式获取：调用服务端创建群会话接口获取的chatid调用前端API获取：小程序会话接口H5微应用会话接口

is_prohibit

boolean

必需

true：开启禁止开关false：关闭禁止开关

示例

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/chat/member/friendswitch/update?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatid": "chatdafe234xxxx",
    "is_prohibit": "true"
}'

返回响应

🟢200成功

application/json

Body

success

boolean

是否设置成功。

可选

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

request_id

string

请求ID。

可选

示例

{
  "success": true,
  "errcode": 0,
  "errmsg": "string",
  "request_id": "string"
}

设置群管理员

获取入群二维码链接

设置禁止群成员私聊

说明#

权限#

请求参数

示例代码

返回响应

说明

权限