Query the list of resignation records

Call this API to query the list of resignation records of your organization, including the resignation date, phone number, and the way each resigned employee left the organization.

API call description

For example, in the Smart HR app of an organization, the resignation records from June 1, 2022 to June 7, 2022 are shown below. The resignation date of employee Xiaoding 2 is June 7, 2022, and the resignation date of DingTalk Test is June 7, 2022. Call this API to query the resignation records from June 1, 2022 to June 7, 2022, and you can retrieve information such as the time when employees Xiaoding 2 and DingTalk Test left the organization, their phone numbers, and how they left the organization.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/contact/empLeaveRecords
HTTP Method	GET
Supported app type	appType-Internal app
Required permission	permission-Contact.Common.Read-Read permission for basic Contacts data

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. To obtain it, call the Get the access token of an internal app API.

Query parameters

Name	Type	Required	Description
startTime	String	Yes	The start time. Format: `YYYY-MM-DDTHH:mm:ssZ` (ISO 8601/RFC 3339).
endTime	String	No	The end time. Format: `YYYY-MM-DDTHH:mm:ssZ` (ISO 8601/RFC 3339). - If this parameter is not specified, the start time must be within 365 days of the current time. - If this parameter is specified, the interval between the start time and end time must not exceed 365 days.
nextToken	String	No	The pagination cursor. - For the first query, set this parameter to 0. - For subsequent queries, set this parameter to the nextToken value returned by the previous call to this API.
maxResults	Integer	Yes	The maximum number of entries per page. Maximum value: 50.

Request example

HTTP

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

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 {

    /**
     * Initialize the account Client with a 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 code and message attributes that 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 code and message attributes that help locate the issue
            }

        }        
    }
}

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:
        """
        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()
        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 code and message attributes that help 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 code and message attributes that 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\ListEmpLeaveRecordsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\ListEmpLeaveRecordsRequest;
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();
        $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 code and message attributes that 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));

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

  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 code and message attributes that help locate the issue
    }

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

  /**
   * Initialize the account Client with a 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 code and message attributes that help 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 a 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 code and message attributes that 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 code and message attributes that help 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 code and message attributes that help locate the issue
    }
  }
}

Response

Response body

Name	Type	Description
nextToken	String	The pagination token for the next request.
records	Array	The list of resignation records.
userId	String	The userId of the employee.
name	String	The name of the employee.
stateCode	String	The international dialing code.
mobile	String	The phone number.
leaveTime	String	The time when the employee left the organization. Format: `YYYY-MM-DDTHH:mm:ssZ` (ISO 8601/RFC 3339).
leaveReason	String	The way the employee left the organization. Valid values: - oapi: Deleted by an API call. - cancel: Account canceled. - leave: Voluntary resignation. - unknown: Unknown reason. - delete: Deleted by the admin.

Response body example

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

{
  "nextToken" : "DCCD7A656FFA6F07",
  "records" : [ {
    "userId" : "10000",
    "name" : "Zhang San",
    "stateCode" : "86",
    "mobile" : "185xxxx7676",
    "leaveTime" : "2021-01-06T11:47:37Z",
    "leaveReason" : "oapi"
  } ]
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document to find a solution based on the error message.

HttpCode	Error code	Error message	Description
400	invalidParameter.param.invalid	Invalid parameter: %s	Invalid parameter
500	system.error	System error	System error

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Query the list of resignation records

API call description

Request

Basic information

Request header

Query parameters

Request example

Response

Response body

Response body example

Error codes

​API call description

​Request

​Basic information

​Request header

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes

API call description

Request

Basic information

Request header

Query parameters

Request example

Response

Response body

Response body example

Error codes