Skip to main content
Call this API to change the DingTalk ID of an Enterprise Account.

API call description

After a DingTalk ID is changed, it cannot be changed again within one year.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/contact/orgAccounts/dingTalkIds/change
HTTP MethodPOST
Supported app typesappType-Internal app
Permissions requiredpermission-qyapi_manage_addresslist-Permission to access the API for maintaining Contacts

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Request body

NameTypeRequiredDescription
userIdStringYesThe userId of the employee. Only the userId of an Enterprise Account that belongs to your organization is supported.
dingTalkIdStringYesThe new DingTalk ID. It must be globally unique, not only unique within the organization. Therefore, it cannot conflict with an existing one; if a conflict occurs, use an alternative value. Format requirements: 6 <= length <= 20, must start with a letter, can contain only letters and digits, and must not contain prohibited content.

Request example

HTTP
POST /v1.0/contact/orgAccounts/dingTalkIds/change HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f788baa23xxxx
Content-Type:application/json

{
  "userId" : "userIdBB",
  "dingTalkId" : "abc123"
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with a Token</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkcontact_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.dingtalkcontact_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkcontact_1_0.models.ChangeDingTalkIdHeaders changeDingTalkIdHeaders = new com.aliyun.dingtalkcontact_1_0.models.ChangeDingTalkIdHeaders();
        changeDingTalkIdHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.ChangeDingTalkIdRequest changeDingTalkIdRequest = new com.aliyun.dingtalkcontact_1_0.models.ChangeDingTalkIdRequest()
                .setUserId("userIdBB")
                .setDingTalkId("abc123");
        try {
            client.changeDingTalkIdWithOptions(changeDingTalkIdRequest, changeDingTalkIdHeaders, 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 the code and message attributes, which 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 the code and message attributes, which help locate the issue
            }

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

from typing import List

from alibabacloud_dingtalk.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__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() -> dingtalkcontact_1_0Client:
        """
        Initialize the account Client with a Token
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkcontact_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        change_ding_talk_id_headers = dingtalkcontact__1__0_models.ChangeDingTalkIdHeaders()
        change_ding_talk_id_headers.x_acs_dingtalk_access_token = '<your access token>'
        change_ding_talk_id_request = dingtalkcontact__1__0_models.ChangeDingTalkIdRequest(
            user_id='userIdBB',
            ding_talk_id='abc123'
        )
        try:
            client.change_ding_talk_id_with_options(change_ding_talk_id_request, change_ding_talk_id_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        change_ding_talk_id_headers = dingtalkcontact__1__0_models.ChangeDingTalkIdHeaders()
        change_ding_talk_id_headers.x_acs_dingtalk_access_token = '<your access token>'
        change_ding_talk_id_request = dingtalkcontact__1__0_models.ChangeDingTalkIdRequest(
            user_id='userIdBB',
            ding_talk_id='abc123'
        )
        try:
            await client.change_ding_talk_id_with_options_async(change_ding_talk_id_request, change_ding_talk_id_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains the code and message attributes, which 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\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ChangeDingTalkIdHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ChangeDingTalkIdRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with a 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();
        $changeDingTalkIdHeaders = new ChangeDingTalkIdHeaders([]);
        $changeDingTalkIdHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $changeDingTalkIdRequest = new ChangeDingTalkIdRequest([
            "userId" => "userIdBB",
            "dingTalkId" => "abc123"
        ]);
        try {
            $client->changeDingTalkIdWithOptions($changeDingTalkIdRequest, $changeDingTalkIdHeaders, 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 the code and message attributes, which 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));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

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

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

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

  changeDingTalkIdHeaders := &dingtalkcontact_1_0.ChangeDingTalkIdHeaders{}
  changeDingTalkIdHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  changeDingTalkIdRequest := &dingtalkcontact_1_0.ChangeDingTalkIdRequest{
    UserId: tea.String("userIdBB"),
    DingTalkId: tea.String("abc123"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ChangeDingTalkIdWithOptions(changeDingTalkIdRequest, changeDingTalkIdHeaders, &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 the code and message attributes, which 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 dingtalkcontact_1_0 = require('@alicloud/dingtalk/contact_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

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

  static async main(args) {
    let client = Client.createClient();
    let changeDingTalkIdHeaders = new dingtalkcontact_1_0.ChangeDingTalkIdHeaders({ });
    changeDingTalkIdHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let changeDingTalkIdRequest = new dingtalkcontact_1_0.ChangeDingTalkIdRequest({
      userId: 'userIdBB',
      dingTalkId: 'abc123',
    });
    try {
      await client.changeDingTalkIdWithOptions(changeDingTalkIdRequest, changeDingTalkIdHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

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 with a Token</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkcontact_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ChangeDingTalkIdHeaders changeDingTalkIdHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ChangeDingTalkIdHeaders();
            changeDingTalkIdHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ChangeDingTalkIdRequest changeDingTalkIdRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ChangeDingTalkIdRequest
            {
                UserId = "userIdBB",
                DingTalkId = "abc123",
            };
            try
            {
                client.ChangeDingTalkIdWithOptions(changeDingTalkIdRequest, changeDingTalkIdHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains the code and message attributes, which 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 the code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanThe execution result.

Response body example

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

{
  "result" : true
}

Error codes

If an error is returned when you call this API, refer to the Global error codes document to find a solution based on the error message.
HttpCodeError codeError messageDescription
400incorrect.formatThe DingTalk ID format is incorrect. Please re-enter it.The DingTalk ID format is incorrect. Please re-enter it.
400have.been.setYou have already set a DingTalk ID and cannot change it.You have already set a DingTalk ID and cannot change it.
400emp.not.existThe employee does not exist.The employee does not exist.
400internalenterpriseaccount.limitOnly Enterprise Accounts belonging to your organization can be processed.Only Enterprise Accounts belonging to your organization can be processed.
400incorrect.lengthThe DingTalk ID format is incorrect. Please re-enter it.The DingTalk ID format is incorrect. Please re-enter it.
400incorrect.reservedThe DingTalk ID is already taken. Please re-enter it.The DingTalk ID is already taken. Please re-enter it.
500system.busyThe system is busy. Please try again later.The system is busy. Please try again later.