创建场景群旧版SDK

更新于 2022-10-18调用本接口根据群模板ID创建群。

警告

为提升用户的使用体验,文档已进行迁移。本文档不再进行维护,请查看最新文档创建场景群

说明
  • 调用本接口前,确保你已经获得了群模板ID。详情请参考申请群模板

  • 场景群创建后,需要监听模板启用事件(chat_template_change),收到事件后场景群才安装完成,才可以发送消息。详情请参考群变更事件

调用本接口,可以群模板ID创建场景群,具体示例如下图所示。

权限

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

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

开发者后台申请。

调试

第三方企业应用

开发者后台申请。

调试

第三方个人应用

基本信息

请求方式:POST

请求地址https://oapi.dingtalk.com/topapi/im/chat/scenegroup/create

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

beE43xx

调用服务端API的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

owner_user_id

String

manager4220

群主的userid。

user_ids

String

user01,user02

群成员userid列表。

uuid

String

asdazxc

建群去重的业务ID。

icon

String

@asdf12zcv

群头像,格式为@mediaId。需要调用上传媒体文件接口上传群头像,获取mediaId。

mention_all_authority

Number

0

@all 权限:

  • 0(默认):所有人都可以@all

  • 1:仅群主可@all

show_history_type

Number

0

新成员是否可查看聊天历史消息:

  • 0(默认):不可以查看历史记录

  • 1:可以查看历史记录

validation_type

Number

0

入群是否需要验证:

  • 0(默认):不验证入群

  • 1:入群验证

searchable

Number

0

群是否可搜索:

  • 0(默认):不可搜索

  • 1:可搜索

chat_banned_type

Number

0

是否开启群禁言:

  • 0(默认):不禁言

  • 1:全员禁言

management_type

Number

0

管理类型:

  • 0(默认):所有人可管理

  • 1:仅群主可管理

title

String

测试群

群名称。

template_id

String

template123

群模板ID。

返回参数

名称

类型

示例值

描述

result

OpenSceneGroupCreateResponse

返回结果。

open_conversation_id

String

cid9FTRQSLo+sKxxxx

群ID。

chat_id

String

chat6d99a92e8xxxx

会话ID。

success

Boolean

true

调用是否成功。

errmsg

String

ok

返回码描述。

errcode

Number

0

返回码。

request_id

String

ed669urokuvq

请求ID。

示例

请求示例(HTTP)

Loading...

请求正文

Loading...

请求示例(JAVA SDK)

Loading...

返回示例

Loading...
这篇文档是否有帮助?
点击纠错