创建群会话

说明

调用本接口创建群会话。
服务地址：https://oapi.dingtalk.com

权限

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

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

请求参数

Query 参数

access_token

string

必需

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

示例值:

6d1bxxxx

Body 参数application/json

name

string

必需

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

owner

string

必需

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

useridlist

array[string]

必需

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

showHistoryType

number

可选

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

searchable

number

可选

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

validationType

number

可选

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

mentionAllAuthority

number

可选

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

managementType

number

可选

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

chatBannedType

number

可选

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

示例

{
  "name": "全员群",
  "owner": "manager4220",
  "useridlist": [
    "userid1",
    "userid2"
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

openConversationId

string

群会话的ID。

可选

chatid

string

可选

群会话的ID。后续版本中chatid将不再使用，请将openConversationId作为群会话唯一标识。

conversationTag

number

可选

会话类型：2：企业群。

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

示例

{
  "openConversationId": "string",
  "chatid": "string",
  "conversationTag": 0,
  "errmsg": "string",
  "errcode": 0
}

说明#

权限#

请求参数

示例代码

返回响应

说明

权限