修改群会话

POST

http://127.0.0.1/chat/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，不支持通过调用前端JSAPI获取的chatid。

name

string

可选

群名称，长度限制为1~20个字符。

owner

string

可选

群主的userid，可通过过根据手机号获取userid接口获取userid。该员工必须为会话useridlist的成员之一。

ownerType

string

可选

群主类型：emp：企业员工ext：外部联系人

add_useridlist

array[string]

可选

添加的群成员列表，每次最多支持40人，群人数上限为1000。可通过根据手机号获取userid接口获取userid。

del_useridlist

array[string]

可选

删除的成员列表。可通过根据手机号获取userid接口获取userid。

add_extidlist

array[string]

可选

添加的外部联系人成员列表。

del_extidlist

array[string]

可选

删除的外部联系人成员列表。

icon

string

可选

群头像的mediaId。

searchable

number

可选

群是否可以被搜索：0（默认）：不可搜索1：可搜索

validationType

number

可选

入群是否需要验证0（默认）：不验证 1：入群验证

mentionAllAuthority

number

可选

@all 使用范围：0（默认）：所有人可使用1：仅群主可@all

managementType

number

可选

群管理类型：0（默认）：所有人可管理1：仅群主可管理

chatBannedType

number

可选

是否开启群禁言：0（默认）：不禁言1：全员禁言

showHistoryType

number

可选

新成员是否可查看100条历史消息：1：可查看0：不可查看如果不传值，代表不可查看。

示例

{
  "owner": "04201724372xxxx",
  "ownerType": "emp",
  "showHistoryType": 0,
  "chatid": "chatxxxx",
  "add_useridlist": [
    "user2"
  ],
  "validationType": 0,
  "del_useridlist": [
    "user1"
  ],
  "icon": "@mediaId",
  "searchable": 0,
  "chatBannedType": 0,
  "managementType": 0,
  "mentionAllAuthority": 0,
  "name": "群名称1",
  "isBan": "true"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/chat/update?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "owner": "04201724372xxxx",
    "ownerType": "emp",
    "showHistoryType": 0,
    "chatid": "chatxxxx",
    "add_useridlist": [
        "user2"
    ],
    "validationType": 0,
    "del_useridlist": [
        "user1"
    ],
    "icon": "@mediaId",
    "searchable": 0,
    "chatBannedType": 0,
    "managementType": 0,
    "mentionAllAuthority": 0,
    "name": "群名称1",
    "isBan": "true"
}'

返回响应

🟢200成功

application/json

Body

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

示例

{
  "errmsg": "string",
  "errcode": 0
}

获取群会话信息

设置群管理员

修改群会话

说明#

权限#

请求参数

示例代码

返回响应

说明

权限