Cari ID pengguna

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	https://api.dingtalk.io/v1.0/contact/users/search
Metode HTTP	POST
Tipe aplikasi yang didukung	appType-Aplikasi internal　appType-Aplikasi perusahaan pihak ketiga
Izin yang wajib	permission-qyapi_addresslist_search-Izin untuk mencari Kontak organisasi

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses yang digunakan untuk memanggil API ini. Peroleh sebagai berikut: - Untuk aplikasi internal, panggil API Peroleh access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Peroleh access token organisasi yang diberi otorisasi ke aplikasi pihak ketiga.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
queryWord	String	Ya	Nama pengguna, nama dalam pinyin, atau nama dalam bahasa Inggris.
offset	Integer	Ya	Nomor halaman.
size	Integer	Ya	Ukuran halaman.
fullMatchField	Integer	Tidak	Menentukan apakah akan melakukan pencocokan tepat. - 1: Mencocokkan nama pengguna secara tepat. Jika parameter ini tidak ditentukan, pencocokan fuzzy dilakukan pada nama pengguna secara default.

Contoh permintaan

HTTP

POST /v1.0/contact/users/search HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json

{
  "queryWord" : "Alice",
  "offset" : 0,
  "size" : 10,
  "fullMatchField" : 1
}

Java

// File ini dibuat otomatis, jangan edit. Terima kasih.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Inisialisasi Client akun dengan Token
     * @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.SearchUserHeaders searchUserHeaders = new com.aliyun.dingtalkcontact_1_0.models.SearchUserHeaders();
        searchUserHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkcontact_1_0.models.SearchUserRequest searchUserRequest = new com.aliyun.dingtalkcontact_1_0.models.SearchUserRequest()
                .setQueryWord("Alice")
                .setOffset(0)
                .setSize(10)
                .setFullMatchField(1);
        try {
            client.searchUserWithOptions(searchUserRequest, searchUserHeaders, 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 berisi properti code dan message, yang membantu menemukan 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 berisi properti code dan message, yang membantu menemukan issue
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# File ini dibuat otomatis, jangan edit. Terima kasih.
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:
        """
        Inisialisasi Client akun dengan 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()
        search_user_headers = dingtalkcontact__1__0_models.SearchUserHeaders()
        search_user_headers.x_acs_dingtalk_access_token = '<your access token>'
        search_user_request = dingtalkcontact__1__0_models.SearchUserRequest(
            query_word='Alice',
            offset=0,
            size=10,
            full_match_field=1
        )
        try:
            client.search_user_with_options(search_user_request, search_user_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message, yang membantu menemukan issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        search_user_headers = dingtalkcontact__1__0_models.SearchUserHeaders()
        search_user_headers.x_acs_dingtalk_access_token = '<your access token>'
        search_user_request = dingtalkcontact__1__0_models.SearchUserRequest(
            query_word='Alice',
            offset=0,
            size=10,
            full_match_field=1
        )
        try:
            await client.search_user_with_options_async(search_user_request, search_user_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi properti code dan message, yang membantu menemukan issue
                pass

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

PHP

<?php

// File ini dibuat otomatis, jangan edit. Terima kasih.
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\SearchUserHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\SearchUserRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Inisialisasi Client akun dengan 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();
        $searchUserHeaders = new SearchUserHeaders([]);
        $searchUserHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $searchUserRequest = new SearchUserRequest([
            "queryWord" => "Alice",
            "offset" => 0,
            "size" => 10,
            "fullMatchField" => 1
        ]);
        try {
            $client->searchUserWithOptions($searchUserRequest, $searchUserHeaders, 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 berisi properti code dan message, yang membantu menemukan 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));

// File ini dibuat otomatis, jangan edit. Terima kasih.
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"
)

/**
 * Inisialisasi Client akun dengan 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
  }

  searchUserHeaders := &dingtalkcontact_1_0.SearchUserHeaders{}
  searchUserHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  searchUserRequest := &dingtalkcontact_1_0.SearchUserRequest{
    QueryWord: tea.String("Alice"),
    Offset: tea.Int32(0),
    Size: tea.Int32(10),
    FullMatchField: tea.Int32(1),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SearchUserWithOptions(searchUserRequest, searchUserHeaders, &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 berisi properti code dan message, yang membantu menemukan issue
    }

  }
  return _err
}

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

Node.js

// File ini dibuat otomatis, jangan edit
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 {

  /**
   * Inisialisasi Client akun dengan Token
   * @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 searchUserHeaders = new $dingtalkcontact_1_0.SearchUserHeaders({ });
    searchUserHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let searchUserRequest = new $dingtalkcontact_1_0.SearchUserRequest({
      queryWord: "Alice",
      offset: 0,
      size: 10,
      fullMatchField: 1,
    });
    try {
      await client.searchUserWithOptions(searchUserRequest, searchUserHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err berisi properti code dan message, yang membantu menemukan issue
      }

    }    
  }

}

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

// File ini dibuat otomatis, jangan edit. Terima kasih.

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 
    {

        /**
         * Inisialisasi Client akun dengan Token
         * @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.SearchUserHeaders searchUserHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SearchUserHeaders();
            searchUserHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SearchUserRequest searchUserRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SearchUserRequest
            {
                QueryWord = "Alice",
                Offset = 0,
                Size = 10,
                FullMatchField = 1,
            };
            try
            {
                client.SearchUserWithOptions(searchUserRequest, searchUserHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err berisi properti code dan message, yang membantu menemukan 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 berisi properti code dan message, yang membantu menemukan issue
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
hasMore	Boolean	Menunjukkan apakah ada lebih banyak data yang tersedia. - true: Ya - false: Tidak
totalCount	Long	Jumlah total record.
list	Array of String	ID pengguna.

Contoh isi respons

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

{
  "hasMore" : false,
  "totalCount" : 2,
  "list" : [ "220141953" ]
}

Kode error

Jika error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
400	parameter.error	parameter error	Error parameter
500	system.busy	system error	Error sistem

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Cari ID pengguna

Cari ID pengguna

Permintaan

Informasi dasar

Header permintaan

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Cari ID pengguna

​Permintaan

​Informasi dasar

​Header permintaan

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Cari ID pengguna

Permintaan

Informasi dasar

Header permintaan

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error