选择应用类型
企业内部应用开发

启用群模板旧版SDK

更新于 2024-02-27

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月,当前接口会消耗调用次数。若该调用量无法满足需求,你可升级钉钉专业版(Open API调用量50万次/月)钉钉专属版(Open API调用量500万次/月)扩容调用次数。
调用本接口根据群模板ID启用群模板。

调用本接口,根据群模板ID、群ID启用群模板,生效群模板配置项、安装群模板机器人、开启群模板快捷入口,启用后如下图所示。

说明

支持以下场景使用:

  • 基于群模板创建的群。

    • 企业内部应用,详情参见创建群

    • 第三方企业应用,详情参见创建群

权限

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

应用类型

是否支持调用

权限申请方式

API Explorer调试

企业内部应用

支持

钉钉群基础信息管理权限

API Explorer

第三方企业应用

支持

钉钉群基础信息管理权限

API Explorer

第三方个人应用

暂不支持

钉钉群基础信息管理权限

暂不支持

基本信息

请求方式:POST

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

Query参数

名称

类型

是否必填

示例值

描述

access_token

String

bes1*****

调用该接口的应用凭证。

Body参数

名称

类型

是否必填

示例值

描述

owner_user_id

String

013*****

群主的userid。

template_id

String

c354***-***-***-b4ea-6f1ab***65

群模板id,登录开发者后台 > 开放能力 > 场景群 > 群模板查看id:

说明

调用本接口前,需要在钉钉开发者后台为群模板设置灰度企业。

open_conversation_id

String

cid9FTRQSLo+sK*****==

群ID。

  • 企业内部应用,调用创建群接口获取open_conversation_id参数值。

  • 第三方企业应用,调用创建群接口获取open_conversation_id参数值。

返回参数

名称

类型

示例值

描述

success

Boolean

true

调用是否成功。

errmsg

String

ok

返回码描述。

errcode

Number

0

返回码。

示例

请求示例(HTTP)

Loading...

请求正文

Loading...

请求示例(JAVA SDK,接口使用旧版服务端SDK,参见服务端SDK

Loading...

返回示例

Loading...

错误码

错误码(errorcode)

错误信息描述(errmsg)

解决方案

665036

群模板不存在或停用

确认群模板id是否正确

660023

群ID解码失败

确认群id是否正确

500

系统异常

优先确认群id,群模板id是否正确,请稍后重试

点击纠错