Set group admins in bulk

Call this API to assign multiple users in an organization’s group chat as admins in bulk, or to revoke the admin role from multiple users in bulk. This API is suitable for scenarios where the organization’s group chat is large and admins need to be adjusted in bulk to improve management efficiency, or when the organizational structure is adjusted and group admins need to be reassigned.

Permissions

To call this API, one of the following permissions is required.

App type	Supported	Permissions	API Explorer debugging
Internal app	Supported	Permissions to manage basic information about DingTalk groups	API Explorer
Third-party enterprise app	Not supported	Not supported	Not supported
Third-party personal app	Not supported	Not supported	Not supported

HTTP method

POST /v1.0/im/subAdministrators HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:String
Content-Type:application/json

{
  "openConversationId" : "String",
  "userIds" : [ "String" ],
  "role" : Integer
}

Header parameters

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain it, call the Get the access token of an internal app API.

Body parameters

Name	Type	Required	Description
openConversationId	String	Yes	The open group ID. To obtain the value of `openConversationId`, call the Create a group chat API.
userIds	Array of String	Yes	The list of `userid` values of employees in the organization. To obtain the value of `userid_list`, call the Query the list of department user IDs API.
role	Integer	Yes	The operation type. Valid values: - 2: Add as an admin. - 3: Remove from admins.

Response parameters

Name	Type	Description
success	String	Whether the call was successful: - true: Success. - false: Failed.

Examples

Request example

HTTP

POST /v1.0/im/subAdministrators HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:862bcxxx
Content-Type:application/json

{
  "openConversationId" : "cidVwhxxxx=",
  "userIds" : [ "wZxxxxGJGy" ],
  "role" : 2
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkim_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkim_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkim_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkim_1_0.models.ChatSubAdminUpdateHeaders chatSubAdminUpdateHeaders = new com.aliyun.dingtalkim_1_0.models.ChatSubAdminUpdateHeaders();
        chatSubAdminUpdateHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkim_1_0.models.ChatSubAdminUpdateRequest chatSubAdminUpdateRequest = new com.aliyun.dingtalkim_1_0.models.ChatSubAdminUpdateRequest()
                .setOpenConversationId("cidVwhxxxx=")
                .setUserIds(java.util.Arrays.asList(
                    "wZxxxxGJGy"
                ))
                .setRole(2);
        try {
            client.chatSubAdminUpdateWithOptions(chatSubAdminUpdateRequest, chatSubAdminUpdateHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err contains code and message properties to help locate the issue
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.im_1_0.client import Client as dingtalkim_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.im_1_0 import models as dingtalkim__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkim_1_0Client:
        """
        Initialize the account Client using Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkim_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        chat_sub_admin_update_headers = dingtalkim__1__0_models.ChatSubAdminUpdateHeaders()
        chat_sub_admin_update_headers.x_acs_dingtalk_access_token = '<your access token>'
        chat_sub_admin_update_request = dingtalkim__1__0_models.ChatSubAdminUpdateRequest(
            open_conversation_id='cidVwhxxxx=',
            user_ids=[
                'wZxxxxGJGy'
            ],
            role=2
        )
        try:
            client.chat_sub_admin_update_with_options(chat_sub_admin_update_request, chat_sub_admin_update_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        chat_sub_admin_update_headers = dingtalkim__1__0_models.ChatSubAdminUpdateHeaders()
        chat_sub_admin_update_headers.x_acs_dingtalk_access_token = '<your access token>'
        chat_sub_admin_update_request = dingtalkim__1__0_models.ChatSubAdminUpdateRequest(
            open_conversation_id='cidVwhxxxx=',
            user_ids=[
                'wZxxxxGJGy'
            ],
            role=2
        )
        try:
            await client.chat_sub_admin_update_with_options_async(chat_sub_admin_update_request, chat_sub_admin_update_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help locate the issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vim_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vim_1_0\Models\ChatSubAdminUpdateHeaders;
use AlibabaCloud\SDK\Dingtalk\Vim_1_0\Models\ChatSubAdminUpdateRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using Token
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $chatSubAdminUpdateHeaders = new ChatSubAdminUpdateHeaders([]);
        $chatSubAdminUpdateHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $chatSubAdminUpdateRequest = new ChatSubAdminUpdateRequest([
            "openConversationId" => "cidVwhxxxx=",
            "userIds" => [
                "wZxxxxGJGy"
            ],
            "role" => 2
        ]);
        try {
            $client->chatSubAdminUpdateWithOptions($chatSubAdminUpdateRequest, $chatSubAdminUpdateHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err contains code and message properties to help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkim_1_0  "github.com/alibabacloud-go/dingtalk/im_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// Initialize the account Client using Token
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkim_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkim_1_0.Client{}
  _result, _err = dingtalkim_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  chatSubAdminUpdateHeaders := &dingtalkim_1_0.ChatSubAdminUpdateHeaders{}
  chatSubAdminUpdateHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  chatSubAdminUpdateRequest := &dingtalkim_1_0.ChatSubAdminUpdateRequest{
    OpenConversationId: tea.String("cidVwhxxxx="),
    UserIds: []*string{tea.String("wZxxxxGJGy")},
    Role: tea.Int32(2),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ChatSubAdminUpdateWithOptions(chatSubAdminUpdateRequest, chatSubAdminUpdateHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err contains code and message properties to help locate the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkim_1_0 = require('@alicloud/dingtalk/im_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * Initialize the account Client using Token
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkim_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let chatSubAdminUpdateHeaders = new dingtalkim_1_0.ChatSubAdminUpdateHeaders({ });
    chatSubAdminUpdateHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let chatSubAdminUpdateRequest = new dingtalkim_1_0.ChatSubAdminUpdateRequest({
      openConversationId: 'cidVwhxxxx=',
      userIds: [
        'wZxxxxGJGy'
      ],
      role: 2,
    });
    try {
      await client.chatSubAdminUpdateWithOptions(chatSubAdminUpdateRequest, chatSubAdminUpdateHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties to help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));

using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>Initialize the account Client using Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkim_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkim_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkim_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkim_1_0.Models.ChatSubAdminUpdateHeaders chatSubAdminUpdateHeaders = new AlibabaCloud.SDK.Dingtalkim_1_0.Models.ChatSubAdminUpdateHeaders();
            chatSubAdminUpdateHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkim_1_0.Models.ChatSubAdminUpdateRequest chatSubAdminUpdateRequest = new AlibabaCloud.SDK.Dingtalkim_1_0.Models.ChatSubAdminUpdateRequest
            {
                OpenConversationId = "cidVwhxxxx=",
                UserIds = new List<string>
                {
                    "wZxxxxGJGy"
                },
                Role = 2,
            };
            try
            {
                client.ChatSubAdminUpdateWithOptions(chatSubAdminUpdateRequest, chatSubAdminUpdateHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help locate the issue
                }
            }
        }

    }
}

Response example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "success" : "true"
}

Error codes

HttpCode	Error code	Error message	Description
400	invalidParameter.openConversationId.invalid	Invalid conversation ID.	Invalid conversation ID.
400	invalidParameter.orgId.invalid	Invalid organization ID.	Invalid organization ID.
400	invalid.staffid	Invalid userId.	Invalid userId.
400	subadmin.exceed	The admin limit has been exceeded.	The admin limit has been exceeded.
400	invalidParamter.role	Invalid role.	Invalid role.
400	staff.not.found	Employee not found.	Employee not found.
400	permession.checkFailed	The group owner is outside the app’s visibility scope.	The group owner is outside the app’s visibility scope.
400	group.diaband	The group has been disbanded.	The group has been disbanded.
500	system.error	System error.	System error.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Permissions

HTTP method

Header parameters

Body parameters

Response parameters

Examples

Request example

Response example

Error codes

​Permissions

​HTTP method

​Header parameters

​Body parameters

​Response parameters

​Examples

​Request example

​Response example

​Error codes

Permissions

HTTP method

Header parameters

Body parameters

Response parameters

Examples

Request example

Response example

Error codes