Deskripsi panggilan API
Pada skenario tertentu ketika Anda perlu segera memaksa keluar sebuah Akun Perusahaan, panggil API ini untuk melakukan pengeluaran paksa. Setelah keluar, DingTalk di sisi pengguna ditampilkan seperti di bawah ini:Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/contact/orgAccounts/signOut |
| Metode HTTP | POST |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-Contact.OrgAccountSecurity.ReadWrite-Izin baca dan tulis untuk data keamanan Akun Perusahaan Kontak |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Peroleh dengan memanggil Dapatkan access token dari aplikasi internal. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| userId | String | Ya | ID pengguna dari Akun Perusahaan. Peroleh melalui salah satu dari empat metode berikut: - Dapatkan ID pengguna berdasarkan nomor telepon - Buat Akun Perusahaan SSO - Buat Akun Perusahaan yang dibuat oleh DingTalk - Undang Akun Perusahaan dari organisasi lain untuk bergabung |
| reason | String | Tidak | Alasan pengeluaran paksa Akun Perusahaan (ditampilkan di log audit konsol admin DingTalk). |
| reasonI18nForEmployee | Map<String, String> | Tidak | - Alasan pengeluaran paksa Akun Perusahaan (ditampilkan kepada karyawan). - Contoh: {"zh_CN":"Alasan keluar","en_US":"Alasan keluar"} - Bahasa yang didukung mengacu pada bahasa saat ini dari klien DingTalk. Misalnya: zh_CN, zh_HK, zh_TW, en_US, ja_JP, vi_VN, fr_FR, ru_RU, ko_KR, es_LA, tr_TR, pt_BR, ms_MY, id_ID, th_TH. |
Contoh permintaan
HTTPPOST /v1.0/contact/orgAccounts/signOut HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BExxx
Content-Type:application/json
{
"userId" : "user123",
"reason" : "Akun dinonaktifkan",
"reasonI18nForEmployee" : {
{"zh_CN":"Administrator telah mengeluarkan Anda. Jika Anda memiliki pertanyaan, hubungi administrator."}
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using 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 {
com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkcontact_1_0.models.SignOutHeaders signOutHeaders = new com.aliyun.dingtalkcontact_1_0.models.SignOutHeaders();
signOutHeaders.xAcsDingtalkAccessToken = "<your access token>";
java.util.Map<String, String> reasonI18nForEmployee = TeaConverter.buildMap(
new TeaPair("key", "-")
);
com.aliyun.dingtalkcontact_1_0.models.SignOutRequest signOutRequest = new com.aliyun.dingtalkcontact_1_0.models.SignOutRequest()
.setUserId("user123")
.setReason("Account deactivated")
.setReasonI18nForEmployee(reasonI18nForEmployee)
.setOpenDeviceId("-");
try {
client.signOutWithOptions(signOutRequest, signOutHeaders, 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 atribut code dan message, yang membantu developer 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 atribut code dan message, yang membantu developer menemukan issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json
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 using 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()
sign_out_headers = dingtalkcontact__1__0_models.SignOutHeaders()
sign_out_headers.x_acs_dingtalk_access_token = '<your access token>'
reason_i18n_for_employee = {
'key': '-'
}
sign_out_request = dingtalkcontact__1__0_models.SignOutRequest(
user_id='user123',
reason='Account deactivated',
reason_i18n_for_employee=reason_i18n_for_employee,
open_device_id='-'
)
try:
client.sign_out_with_options(sign_out_request, sign_out_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message, yang membantu developer menemukan issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
sign_out_headers = dingtalkcontact__1__0_models.SignOutHeaders()
sign_out_headers.x_acs_dingtalk_access_token = '<your access token>'
reason_i18n_for_employee = {
'key': '-'
}
sign_out_request = dingtalkcontact__1__0_models.SignOutRequest(
user_id='user123',
reason='Account deactivated',
reason_i18n_for_employee=reason_i18n_for_employee,
open_device_id='-'
)
try:
await client.sign_out_with_options_async(sign_out_request, sign_out_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err berisi atribut code dan message, yang membantu developer menemukan 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\SignOutHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\SignOutRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$signOutHeaders = new SignOutHeaders([]);
$signOutHeaders->xAcsDingtalkAccessToken = "<your access token>";
$reasonI18nForEmployee = [
"key" => "-"
];
$signOutRequest = new SignOutRequest([
"userId" => "user123",
"reason" => "Account deactivated",
"reasonI18nForEmployee" => $reasonI18nForEmployee,
"openDeviceId" => "-"
]);
try {
$client->signOutWithOptions($signOutRequest, $signOutHeaders, 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 atribut code dan message, yang membantu developer 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));
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 using 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
}
signOutHeaders := &dingtalkcontact_1_0.SignOutHeaders{}
signOutHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
reasonI18nForEmployee := map[string]*string{
"key": tea.String("-"),
}
signOutRequest := &dingtalkcontact_1_0.SignOutRequest{
UserId: tea.String("user123"),
Reason: tea.String("Account deactivated"),
ReasonI18nForEmployee: reasonI18nForEmployee,
OpenDeviceId: tea.String("-"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SignOutWithOptions(signOutRequest, signOutHeaders, &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 atribut code dan message, yang membantu developer menemukan issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'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 using 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 signOutHeaders = new dingtalkcontact_1_0.SignOutHeaders({ });
signOutHeaders.xAcsDingtalkAccessToken = '<your access token>';
let reasonI18nForEmployee = {
key: '-',
};
let signOutRequest = new dingtalkcontact_1_0.SignOutRequest({
userId: 'user123',
reason: 'Account deactivated',
reasonI18nForEmployee: reasonI18nForEmployee,
openDeviceId: '-',
});
try {
await client.signOutWithOptions(signOutRequest, signOutHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err berisi atribut code dan message, yang membantu developer menemukan issue
}
}
}
}
exports.Client = Client;
Client.main(process.argv.slice(2));
using Newtonsoft.Json;
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 using 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.SignOutHeaders signOutHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutHeaders();
signOutHeaders.XAcsDingtalkAccessToken = "<your access token>";
Dictionary<string, string> reasonI18nForEmployee = new Dictionary<string, string>
{
{"key", "-"},
};
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutRequest signOutRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.SignOutRequest
{
UserId = "user123",
Reason = "Account deactivated",
ReasonI18nForEmployee = reasonI18nForEmployee,
OpenDeviceId = "-",
};
try
{
client.SignOutWithOptions(signOutRequest, signOutHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err berisi atribut code dan message, yang membantu developer 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 atribut code dan message, yang membantu developer menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Boolean | Apakah pengeluaran berhasil. true menandakan berhasil. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : true
}
Kode error
Jika panggilan API mengembalikan error, lihat dokumen Kode error global dan temukan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalid.param | Invalid parameter | Parameter tidak valid |
| 400 | user.not.exist | User does not exist | Pengguna tidak ada |
| 400 | exclusive.account.only | Only dedicated accounts belonging to this organization can be operated on | Hanya akun khusus milik organisasi ini yang dapat dioperasikan |
| 500 | system.busy | System busy | Sistem sibuk |