企業の招待情報を取得

本インターフェースを呼び出して、企業の招待情報を取得します。

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/contact/invites/infos
HTTP Method	GET
対応アプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-Contact.Common.Read-連絡先ベーシックデータ読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	本インターフェースを呼び出すためのアクセス認証情報。以下の方法で取得します： - 社内アプリの場合、社内アプリのアクセストークンを取得インターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業のアクセストークンを取得インターフェースを呼び出して取得します。

クエリパラメータ

名前	タイプ	必須	説明
inviterUserId	String	いいえ	招待者の userId。詳細はベーシック概念-UserId を参照してください。本パラメータを指定しない場合、デフォルトの招待者は現在の企業作成者の userId となります。
deptId	Long	いいえ	部門招待リンクを取得する部門 ID。

リクエスト例

HTTP

GET /v1.0/contact/invites/infos?inviterUserId=user123&deptId=6612366 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:acc2343exxxx
Content-Type:application/json

Java

// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkcontact_1_0.*;
import com.aliyun.dingtalkcontact_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;

public class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @return Client
     * @throws Exception
     */
    public static com.aliyun.dingtalkcontact_1_0.Client createClient() throws Exception {
        Config config = new 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();
        GetApplyInviteInfoHeaders getApplyInviteInfoHeaders = new GetApplyInviteInfoHeaders();
        getApplyInviteInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetApplyInviteInfoRequest getApplyInviteInfoRequest = new GetApplyInviteInfoRequest()
                .setInviterUserId("user123")
                .setDeptId(6612366L);
        try {
            client.getApplyInviteInfoWithOptions(getApplyInviteInfoRequest, getApplyInviteInfoHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
            }

        } 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 には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
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:
        """
        トークンを使用してアカウント Client を初期化
        @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()
        get_apply_invite_info_headers = dingtalkcontact__1__0_models.GetApplyInviteInfoHeaders()
        get_apply_invite_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_apply_invite_info_request = dingtalkcontact__1__0_models.GetApplyInviteInfoRequest(
            inviter_user_id='user123',
            dept_id=6612366
        )
        try:
            client.get_apply_invite_info_with_options(get_apply_invite_info_request, get_apply_invite_info_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_apply_invite_info_headers = dingtalkcontact__1__0_models.GetApplyInviteInfoHeaders()
        get_apply_invite_info_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_apply_invite_info_request = dingtalkcontact__1__0_models.GetApplyInviteInfoRequest(
            inviter_user_id='user123',
            dept_id=6612366
        )
        try:
            await client.get_apply_invite_info_with_options_async(get_apply_invite_info_request, get_apply_invite_info_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
                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\GetApplyInviteInfoHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\GetApplyInviteInfoRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント Client を初期化
     * @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();
        $getApplyInviteInfoHeaders = new GetApplyInviteInfoHeaders([]);
        $getApplyInviteInfoHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getApplyInviteInfoRequest = new GetApplyInviteInfoRequest([
            "inviterUserId" => "user123",
            "deptId" => 6612366
        ]);
        try {
            $client->getApplyInviteInfoWithOptions($getApplyInviteInfoRequest, $getApplyInviteInfoHeaders, 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 には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

// This file is auto-generated, don't edit it. Thanks.
package main

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

/**
 * トークンを使用してアカウント Client を初期化
 * @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
  }

  getApplyInviteInfoHeaders := &dingtalkcontact_1_0.GetApplyInviteInfoHeaders{}
  getApplyInviteInfoHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getApplyInviteInfoRequest := &dingtalkcontact_1_0.GetApplyInviteInfoRequest{
    InviterUserId: tea.String("user123"),
    DeptId: tea.Int64(6612366),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetApplyInviteInfoWithOptions(getApplyInviteInfoRequest, getApplyInviteInfoHeaders, &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 には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
    }

  }
  return _err
}

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

Node.js

// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * トークンを使用してアカウント Client を初期化
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkcontact_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkcontact_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let getApplyInviteInfoHeaders = new $dingtalkcontact_1_0.GetApplyInviteInfoHeaders({ });
    getApplyInviteInfoHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getApplyInviteInfoRequest = new $dingtalkcontact_1_0.GetApplyInviteInfoRequest({
      inviterUserId: "user123",
      deptId: 6612366,
    });
    try {
      await client.getApplyInviteInfoWithOptions(getApplyInviteInfoRequest, getApplyInviteInfoHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
      }

    }    
  }

}

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

// 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 
    {

        /**
         * トークンを使用してアカウント Client を初期化
         * @return Client
         * @throws 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.GetApplyInviteInfoHeaders getApplyInviteInfoHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetApplyInviteInfoHeaders();
            getApplyInviteInfoHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetApplyInviteInfoRequest getApplyInviteInfoRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetApplyInviteInfoRequest
            {
                InviterUserId = "user123",
                DeptId = 6612366,
            };
            try
            {
                client.GetApplyInviteInfoWithOptions(getApplyInviteInfoRequest, getApplyInviteInfoHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
                }
            }
            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 には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
                }
            }
        }

    }
}

// This file is auto-generated, don't edit it. Thanks.

#include <alibabacloud/dingtalkcontact__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>

using namespace std;

Alibabacloud_Dingtalkcontact_1_0::Client createClient() {
  shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
  config->protocol = make_shared<string>("https");
  config->regionId = make_shared<string>("central");
  return Alibabacloud_Dingtalkcontact_1_0::Client(config);
}

int main(int argc, char *args[]) {
  args;
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcontact_1_0::Client>(createClient());
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::GetApplyInviteInfoHeaders> getApplyInviteInfoHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetApplyInviteInfoHeaders>();
  getApplyInviteInfoHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::GetApplyInviteInfoRequest> getApplyInviteInfoRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetApplyInviteInfoRequest>(map<string, boost::any>({
    {"inviterUserId", boost::any(string("user123"))},
    {"deptId", boost::any(6612366)}
  }));
  try {
    client->getApplyInviteInfoWithOptions(getApplyInviteInfoRequest, getApplyInviteInfoHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
  }
  catch (std::exception &err) {
    if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
      // err には code と message 属性が含まれており、開発者が問題を特定するのに役立ちます
    }
  }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
inviteSwitch	Boolean	招待をオンにするかどうか。 - true：オン - false：オフ
searchNameInvite	Boolean	企業名検索による申請をオンにするかどうか。 - true：オン - false：オフ
orgApplyCodeInvite	Boolean	チーム番号による参加申請をオンにするかどうか。 - true：オン - false：オフ
linkInvite	Boolean	リンクによる招待参加をオンにするかどうか。 - true：オン - false：オフ
inviteUrl	String	招待リンク。
auditType	Long	審査タイプ。 - 0：審査不要 - 1：権限を持つサブ管理者部門招待のみ有効です。
empApplyJoinDept	Boolean	社員が QR コードをスキャンして部門に参加することを許可するかどうか。 - true：許可 - false：不許可審査不要の場合のみ有効で、既に組織内にいるユーザーが部門 QR コードをスキャンして特定の部門に参加できます。

レスポンスボディ例

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

{
  "inviteSwitch" : true,
  "searchNameInvite" : true,
  "orgApplyCodeInvite" : true,
  "linkInvite" : true,
  "inviteUrl" : "https://dingtalk.io",
  "auditType" : 1,
  "empApplyJoinDept" : false
}

エラーコード

本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージに基づいてグローバルエラーコードドキュメントで解決策を検索できます。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidParameter.param.empty	パラメータが空です	パラメータが空です
400	invalidParameter.param.orgIdInvalid	企業が存在しないか、既に解散しています	企業が存在しないか、既に解散しています
500	invalid.system.errror	システムエラー	システムエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード