Skip to main content
Authorize specific fields of the current organization’s Enterprise Account to be visible to other organizations after the account joins those organizations.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/contact/orgAccounts/mobiles/visibleInOtherOrg
HTTP MethodPUT
Supported app typeappType-Internal app
Permissions requiredpermission-Contact.OrgAccount.VisiblityInOtherOrg-Data visibility permission for Enterprise Accounts after joining other organizations

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
toCorpIdsArray of StringYesThe list of organization IDs (corpId) of the authorized organizations. The list of corpIds of the authorized organizations and the userId of the API caller cannot be empty. Invalid parameters will cause the API call to fail.
optUserIdStringYesThe userId of the current API caller. Used for data auditing. You must provide a valid employee userId from the current organization; otherwise, the API call will fail.
fieldsArray of StringNoAuthorized fields: If fields is empty or an empty collection, only mobile is authorized (for backward compatibility). - mobile: The mobile number of the Enterprise Account. - status: The deactivation status of the Enterprise Account.

Request example

HTTP
PUT /v1.0/contact/orgAccounts/mobiles/visibleInOtherOrg HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:101w3c04ffa2386da6530e5123bdf260
Content-Type:application/json

{
  "toCorpIds" : [ "ding12345678" ],
  "optUserId" : "102530009661373952",
  "fields" : [ "mobile" ]
}
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.OrgAccountMobileVisibleInOtherOrgHeaders orgAccountMobileVisibleInOtherOrgHeaders = new com.aliyun.dingtalkcontact_1_0.models.OrgAccountMobileVisibleInOtherOrgHeaders();
        orgAccountMobileVisibleInOtherOrgHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.OrgAccountMobileVisibleInOtherOrgRequest orgAccountMobileVisibleInOtherOrgRequest = new com.aliyun.dingtalkcontact_1_0.models.OrgAccountMobileVisibleInOtherOrgRequest()
                .setToCorpIds(java.util.Arrays.asList(
                    "ding12345678"
                ))
                .setOptUserId("102530009661373952")
                .setFields(java.util.Arrays.asList(
                    "mobile"
                ));
        try {
            client.orgAccountMobileVisibleInOtherOrgWithOptions(orgAccountMobileVisibleInOtherOrgRequest, orgAccountMobileVisibleInOtherOrgHeaders, 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 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 the code and message attributes to 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()
        org_account_mobile_visible_in_other_org_headers = dingtalkcontact__1__0_models.OrgAccountMobileVisibleInOtherOrgHeaders()
        org_account_mobile_visible_in_other_org_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_account_mobile_visible_in_other_org_request = dingtalkcontact__1__0_models.OrgAccountMobileVisibleInOtherOrgRequest(
            to_corp_ids=[
                'ding12345678'
            ],
            opt_user_id='102530009661373952',
            fields=[
                'mobile'
            ]
        )
        try:
            client.org_account_mobile_visible_in_other_org_with_options(org_account_mobile_visible_in_other_org_request, org_account_mobile_visible_in_other_org_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 to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        org_account_mobile_visible_in_other_org_headers = dingtalkcontact__1__0_models.OrgAccountMobileVisibleInOtherOrgHeaders()
        org_account_mobile_visible_in_other_org_headers.x_acs_dingtalk_access_token = '<your access token>'
        org_account_mobile_visible_in_other_org_request = dingtalkcontact__1__0_models.OrgAccountMobileVisibleInOtherOrgRequest(
            to_corp_ids=[
                'ding12345678'
            ],
            opt_user_id='102530009661373952',
            fields=[
                'mobile'
            ]
        )
        try:
            await client.org_account_mobile_visible_in_other_org_with_options_async(org_account_mobile_visible_in_other_org_request, org_account_mobile_visible_in_other_org_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 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\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\OrgAccountMobileVisibleInOtherOrgHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\OrgAccountMobileVisibleInOtherOrgRequest;
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();
        $orgAccountMobileVisibleInOtherOrgHeaders = new OrgAccountMobileVisibleInOtherOrgHeaders([]);
        $orgAccountMobileVisibleInOtherOrgHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $orgAccountMobileVisibleInOtherOrgRequest = new OrgAccountMobileVisibleInOtherOrgRequest([
            "toCorpIds" => [
                "ding12345678"
            ],
            "optUserId" => "102530009661373952",
            "fields" => [
                "mobile"
            ]
        ]);
        try {
            $client->orgAccountMobileVisibleInOtherOrgWithOptions($orgAccountMobileVisibleInOtherOrgRequest, $orgAccountMobileVisibleInOtherOrgHeaders, 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 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));
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
  }

  orgAccountMobileVisibleInOtherOrgHeaders := &dingtalkcontact_1_0.OrgAccountMobileVisibleInOtherOrgHeaders{}
  orgAccountMobileVisibleInOtherOrgHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  orgAccountMobileVisibleInOtherOrgRequest := &dingtalkcontact_1_0.OrgAccountMobileVisibleInOtherOrgRequest{
    ToCorpIds: []*string{tea.String("ding12345678")},
    OptUserId: tea.String("102530009661373952"),
    Fields: []*string{tea.String("mobile")},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.OrgAccountMobileVisibleInOtherOrgWithOptions(orgAccountMobileVisibleInOtherOrgRequest, orgAccountMobileVisibleInOtherOrgHeaders, &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 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 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 orgAccountMobileVisibleInOtherOrgHeaders = new dingtalkcontact_1_0.OrgAccountMobileVisibleInOtherOrgHeaders({ });
    orgAccountMobileVisibleInOtherOrgHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let orgAccountMobileVisibleInOtherOrgRequest = new dingtalkcontact_1_0.OrgAccountMobileVisibleInOtherOrgRequest({
      toCorpIds: [
        'ding12345678'
      ],
      optUserId: '102530009661373952',
      fields: [
        'mobile'
      ],
    });
    try {
      await client.orgAccountMobileVisibleInOtherOrgWithOptions(orgAccountMobileVisibleInOtherOrgRequest, orgAccountMobileVisibleInOtherOrgHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes to 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.OrgAccountMobileVisibleInOtherOrgHeaders orgAccountMobileVisibleInOtherOrgHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.OrgAccountMobileVisibleInOtherOrgHeaders();
            orgAccountMobileVisibleInOtherOrgHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.OrgAccountMobileVisibleInOtherOrgRequest orgAccountMobileVisibleInOtherOrgRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.OrgAccountMobileVisibleInOtherOrgRequest
            {
                ToCorpIds = new List<string>
                {
                    "ding12345678"
                },
                OptUserId = "102530009661373952",
                Fields = new List<string>
                {
                    "mobile"
                },
            };
            try
            {
                client.OrgAccountMobileVisibleInOtherOrgWithOptions(orgAccountMobileVisibleInOtherOrgRequest, orgAccountMobileVisibleInOtherOrgHeaders, 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 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 the code and message attributes to help locate the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
resultBooleanThe API call result.

Response body example

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

{
  "result" : true
}

Error codes

If the API call fails, refer to the Global error codes document to find a solution based on the error message.
HttpCodeError codeError messageDescription
400invalid.paramInvalid parameterInvalid parameter
500system.busySystem busySystem busy