API 呼び出し説明
例えば、企業向けスマート人事アプリにおいて、2022年6月1日から2022年6月7日までの退職レコードは下図のとおりで、社員「小钉2」の退職日付は2022年6月7日、「钉钉测试」の退職日付は2022年6月7日です。 本 API を呼び出して 2022年6月1日から2022年6月7日までの退職レコードを照会すると、社員「小钉2」と「钉钉测试」の組織を離れた時刻、電話番号、企業から脱退する方法などの情報を取得できます。リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/empLeaveRecords |
| HTTP Method | GET |
| サポートするアプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-Contact.Common.Read-連絡先基本データ読み取り権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 本 API を呼び出すためのアクセス認証情報です。社内アプリのアクセストークン取得 API を呼び出して取得します。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| startTime | String | はい | 開始時刻。 フォーマット:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。 |
| endTime | String | いいえ | 終了時刻。 フォーマット:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。 - 本パラメータを指定しない場合、開始時刻は現在時刻から 365 日を超えてはなりません。 - 本パラメータを指定する場合、開始時刻と終了時刻の期間は 365 日を超えてはなりません。 |
| nextToken | String | いいえ | ページネーションカーソル。 - 初回照会時は、本パラメータに 0 を指定します。 - 2 回目以降の照会時は、前回呼び出し時に返された nextToken を本パラメータに指定します。 |
| maxResults | Integer | はい | 1 ページあたりの最大エントリ数。最大値は 50 です。 |
リクエスト例
HTTPGET /v1.0/contact/empLeaveRecords?startTime=2020-07-10T00:00:00Z&endTime=2020-08-10T00:00:00Z&nextToken=0&maxResults=10 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:afe814xxx
Content-Type:application/json
// 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 {
/**
* Initialize the account Client with the token
* @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();
ListEmpLeaveRecordsHeaders listEmpLeaveRecordsHeaders = new ListEmpLeaveRecordsHeaders();
listEmpLeaveRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
ListEmpLeaveRecordsRequest listEmpLeaveRecordsRequest = new ListEmpLeaveRecordsRequest()
.setStartTime("2020-07-10T00:00:00Z")
.setEndTime("2020-08-10T00:00:00Z")
.setNextToken("0")
.setMaxResults(10);
try {
client.listEmpLeaveRecordsWithOptions(listEmpLeaveRecordsRequest, listEmpLeaveRecordsHeaders, new 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 properties, which help to 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 properties, which help to locate the issue
}
}
}
}
# -*- 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:
"""
Initialize the account Client with the 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()
list_emp_leave_records_headers = dingtalkcontact__1__0_models.ListEmpLeaveRecordsHeaders()
list_emp_leave_records_headers.x_acs_dingtalk_access_token = '<your access token>'
list_emp_leave_records_request = dingtalkcontact__1__0_models.ListEmpLeaveRecordsRequest(
start_time='2020-07-10T00:00:00Z',
end_time='2020-08-10T00:00:00Z',
next_token='0',
max_results=10
)
try:
client.list_emp_leave_records_with_options(list_emp_leave_records_request, list_emp_leave_records_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 properties, which help to locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
list_emp_leave_records_headers = dingtalkcontact__1__0_models.ListEmpLeaveRecordsHeaders()
list_emp_leave_records_headers.x_acs_dingtalk_access_token = '<your access token>'
list_emp_leave_records_request = dingtalkcontact__1__0_models.ListEmpLeaveRecordsRequest(
start_time='2020-07-10T00:00:00Z',
end_time='2020-08-10T00:00:00Z',
next_token='0',
max_results=10
)
try:
await client.list_emp_leave_records_with_options_async(list_emp_leave_records_request, list_emp_leave_records_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 properties, which help to locate the issue
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\ListEmpLeaveRecordsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListEmpLeaveRecordsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with the 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();
$listEmpLeaveRecordsHeaders = new ListEmpLeaveRecordsHeaders([]);
$listEmpLeaveRecordsHeaders->xAcsDingtalkAccessToken = "<your access token>";
$listEmpLeaveRecordsRequest = new ListEmpLeaveRecordsRequest([
"startTime" => "2020-07-10T00:00:00Z",
"endTime" => "2020-08-10T00:00:00Z",
"nextToken" => "0",
"maxResults" => 10
]);
try {
$client->listEmpLeaveRecordsWithOptions($listEmpLeaveRecordsRequest, $listEmpLeaveRecordsHeaders, 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 properties, which help to 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));
// 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"
)
/**
* Initialize the account Client with the 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
}
listEmpLeaveRecordsHeaders := &dingtalkcontact_1_0.ListEmpLeaveRecordsHeaders{}
listEmpLeaveRecordsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
listEmpLeaveRecordsRequest := &dingtalkcontact_1_0.ListEmpLeaveRecordsRequest{
StartTime: tea.String("2020-07-10T00:00:00Z"),
EndTime: tea.String("2020-08-10T00:00:00Z"),
NextToken: tea.String("0"),
MaxResults: tea.Int32(10),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ListEmpLeaveRecordsWithOptions(listEmpLeaveRecordsRequest, listEmpLeaveRecordsHeaders, &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 properties, which help to locate the issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// 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 {
/**
* Initialize the account Client with the 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 listEmpLeaveRecordsHeaders = new $dingtalkcontact_1_0.ListEmpLeaveRecordsHeaders({ });
listEmpLeaveRecordsHeaders.xAcsDingtalkAccessToken = "<your access token>";
let listEmpLeaveRecordsRequest = new $dingtalkcontact_1_0.ListEmpLeaveRecordsRequest({
startTime: "2020-07-10T00:00:00Z",
endTime: "2020-08-10T00:00:00Z",
nextToken: "0",
maxResults: 10,
});
try {
await client.listEmpLeaveRecordsWithOptions(listEmpLeaveRecordsRequest, listEmpLeaveRecordsHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err contains the code and message properties, which help to locate the issue
}
}
}
}
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
{
/**
* Initialize the account Client with the 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.ListEmpLeaveRecordsHeaders listEmpLeaveRecordsHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpLeaveRecordsHeaders();
listEmpLeaveRecordsHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpLeaveRecordsRequest listEmpLeaveRecordsRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.ListEmpLeaveRecordsRequest
{
StartTime = "2020-07-10T00:00:00Z",
EndTime = "2020-08-10T00:00:00Z",
NextToken = "0",
MaxResults = 10,
};
try
{
client.ListEmpLeaveRecordsWithOptions(listEmpLeaveRecordsRequest, listEmpLeaveRecordsHeaders, 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 properties, which help to 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 properties, which help to locate the issue
}
}
}
}
}
// 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::ListEmpLeaveRecordsHeaders> listEmpLeaveRecordsHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::ListEmpLeaveRecordsHeaders>();
listEmpLeaveRecordsHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::ListEmpLeaveRecordsRequest> listEmpLeaveRecordsRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::ListEmpLeaveRecordsRequest>(map<string, boost::any>({
{"startTime", boost::any(string("2020-07-10T00:00:00Z"))},
{"endTime", boost::any(string("2020-08-10T00:00:00Z"))},
{"nextToken", boost::any(string("0"))},
{"maxResults", boost::any(10)}
}));
try {
client->listEmpLeaveRecordsWithOptions(listEmpLeaveRecordsRequest, listEmpLeaveRecordsHeaders, 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 contains the code and message properties, which help to locate the issue
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| nextToken | String | 次回リクエスト用のページネーション token。 |
| records | Array | 退職レコードリスト。 |
| userId | String | 社員の userId。 |
| name | String | 社員名。 |
| stateCode | String | 国際電話の国番号。 |
| mobile | String | 電話番号。 |
| leaveTime | String | 組織を離れた時刻。 フォーマット:YYYY-MM-DDTHH:mm:ssZ(ISO 8601/RFC 3339)。 |
| leaveReason | String | 企業から脱退する方法。値: - oapi:API 呼び出しによる削除 - cancel:アカウント解約 - leave:自発的な離職 - unknown:理由不明 - delete:管理者による削除 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"nextToken" : "DCCD7A656FFA6F07",
"records" : [ {
"userId" : "10000",
"name" : "山田太郎",
"stateCode" : "86",
"mobile" : "185xxxx7676",
"leaveTime" : "2021-01-06T11:47:37Z",
"leaveReason" : "oapi"
} ]
}
エラーコード
本 API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策をご確認ください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | invalidParameter.param.invalid | 入力パラメータエラー:%s | 入力パラメータエラー |
| 500 | system.error | システムエラー | システムエラー |