Skip to content

创建部门群

适用版本>=v7.0.2412b.20241226

接口说明:创建部门群

使用说明

可基于已有的部门创建一个部门群,单个部门最多支持创建1个群

请求说明

请求地址配置域名+/openapi+/v7/chats/create_dept_chat
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求读写部门群(应用授权)kso.chat_dept.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

请求体(Body)

名称类型是否必填说明
dept_idstring部门ID,可通过通讯录相关接口获取
owner_idstring可指定群主ID

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobject会话信息
idstring会话ID
typestring会话类型 "p2p" "group"
namestring会话名称,默认为部门名称
ctimeinteger创建时间
statusstring会话状态
group_ext_attrsobject群聊会话属性
avatarstring群聊会话头像
avatarsarray[string]群聊会话链接列表
typestring群聊会话头像类型 默认:"default" 自定义:"custom"
owner_idstring群主
dept_idstring部门ID,非空则为部门群
settingsstring会话设置属性
is_disable_all_sendstring全员禁言
is_disable_part_sendstring部分成员禁言
is_enable_nicknamestring开启昵称
is_external_join_approvestring外部企业进群审核
is_join_approvestring进群审核
is_owner_admin_at_allstring只允许群主或管理员@所有人
is_owner_admin_modifystring只允许群主和管理修改群属性

响应体示例

json
{
  "code": 0,
  "data": {
    "ctime": 0,
    "group_ext_attrs": {
      "avatar": {
        "avatars": ["string"],
        "type": "default"
      },
      "dept_id": "string",
      "owner_id": "string",
      "settings": {
        "is_disable_all_send": false,
        "is_disable_part_send": false,
        "is_enable_nickname": true,
        "is_external_join_approve": true,
        "is_join_approve": false,
        "is_owner_admin_at_all": false,
        "is_owner_admin_modify": false
      }
    },
    "id": "string",
    "name": "string",
    "status": "active",
    "type": "group"
  },
  "msg": "success"
}