获取群会话信息

说明

调用本接口获取群设置和成员信息。
服务地址：https://oapi.dingtalk.com

权限

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

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

请求参数

Query 参数

access_token

string

必需

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

示例值:

6d1bxxxx

chatid

string

必需

群会话的ID。仅支持通过调用服务端创建群会话接口获取的chatid，不支持通过调用前端JSAPI获取的chatid。

示例值:

chate39f540dxxxx

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

number

返回码。

可选

errmsg

string

返回码描述。

可选

chat_info

object

群会话信息。

可选

name

string

群名称。

可选

owner

string

可选

群主的userid。

useridlist

array[string]

可选

群成员的userid列表。

conversationTag

number

可选

会话类型：2：企业群。

chatBannedType

number

可选

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

searchable

number

可选

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

validationType

number

可选

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

mentionAllAuthority

number

可选

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

managementType

number

可选

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

showHistoryType

number

可选

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

icon

string

可选

群头像的mediaID。

status

number

可选

状态。1：正常2：已解散

示例

{
  "errcode": 0,
  "errmsg": "string",
  "chat_info": {
    "name": "string",
    "owner": "string",
    "useridlist": [
      "string"
    ],
    "conversationTag": 0,
    "chatBannedType": 0,
    "searchable": 0,
    "validationType": 0,
    "mentionAllAuthority": 0,
    "managementType": 0,
    "showHistoryType": 0,
    "icon": "string",
    "status": 0
  }
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限