> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Asynchronously translate Contacts IDs

> Call this API to launch an asynchronous Contacts ID translation that replaces user IDs and department IDs in documents within the solution provider's permission scope.

# Asynchronously translate Contacts IDs

## API call description

1. Construct the document to be translated, as shown in the following figure.

### Note

Only files in xlsx, xls, csv, and txt formats are supported.

2. Call the [Single-step file upload](https://open.dingtalk.com/document/isvapp/single-step-file-upload) API to obtain the media\_id.
3. Call this API to obtain the translation job ID.

### Note

After this API is called, if the file is translated successfully, an asynchronous job callback notification is triggered.
4\. Call the [Obtain the results of an asynchronous translation task](/open/development/obtains-the-results-of-an-asynchronous-translation-task) API to obtain the download link of the translated file.

### Note

It is recommended to reference the returned file download link with the `<a> tag`. Do not specify the `download` attribute (due to browser compatibility issues).
5\. The file content downloaded by the user is shown in the following figure.

When calling this API, you may encounter the following issue:

* **Issue**: An `excel` file generated with the `NodeJs` third-party library `exceljs` looks fine in content, but the translation fails.
* **Cause**: When `sharedString` is not enabled, `exceljs` writes file content using `formula string` by default. This behavior is non-standard and causes translation to fail.
* **Solution**: Refer to the `exceljs` documentation and force-enable the `useSharedStrings` option.

## Request

### Basic information

| Field                  | Value                                                                                                        |
| ---------------------- | ------------------------------------------------------------------------------------------------------------ |
| HTTP URL               | [https://api.dingtalk.io/v1.0/contact/files/translate](https://api.dingtalk.io/v1.0/contact/files/translate) |
| HTTP Method            | POST                                                                                                         |
| Supported app types    | appType-Third-party enterprise app                                                                           |
| Permission requirement | permission-qyapi\_get\_member-User information read permission                                               |

### Request header

| Name                        | Type   | Required | Description                                                                                                                                                                                                                                                   |
| --------------------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | Yes      | The access credential for calling this API. Obtain it by calling the [Obtain the access token of the enterprise authorized to a third-party app](https://open.dingtalk.com/document/development/obtain-the-access-token-of-the-authorized-enterprise-1#) API. |

### Request body

| Name           | Type                  | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| -------------- | --------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| medias         | `Map<String, String>` | Yes      | The information about the files to be translated.   - A Map type. The key is the Drive file media\_id, which is obtained by calling the [Obtain file upload information](/open/development/obtain-file-upload-informations#) API. - The value is the file name, which must include the file extension and be consistent with the file name passed in when calling the [Obtain file upload information](/open/development/obtain-file-upload-informations#) API.        - Only files in xlsx, xls, csv, and txt formats are supported. - A maximum of 20 files. |
| outputFileName | String                | No       | The name of the packaged file after translation. Do not include a file extension.      This parameter is required if more than one file is specified in medias.                                                                                                                                                                                                                                                                                                                                                                                                |
| unionId        | String                | Yes      | The unionId of the user who currently exports the document. Obtain it by calling the [Obtain user information by silent login code](/open/development/obtain-the-userid-of-a-user-by-using-the-log-free#) API.                                                                                                                                                                                                                                                                                                                                                 |

### Request example

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
POST /v1.0/contact/files/translate HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BWe2xxxx
Content-Type:application/json

{
  "medias" : {
    "key" : "xxxx"
  },
  "outputFileName" : "Study Handbook",
  "unionId" : "fXRUNxxx"
}
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 using 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();
        TranslateFileHeaders translateFileHeaders = new TranslateFileHeaders();
        translateFileHeaders.xAcsDingtalkAccessToken = "<your access token>";
        java.util.Map<String, String> medias = TeaConverter.buildMap(
            new TeaPair("key", "xxxx")
        );
        TranslateFileRequest translateFileRequest = new TranslateFileRequest()
                .setMedias(medias)
                .setOutputFileName("Study Handbook")
                .setUnionId("fXRUNxxx");
        try {
            client.translateFileWithOptions(translateFileRequest, translateFileHeaders, 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, which 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, which help locate the issue
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- 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 using 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()
        translate_file_headers = dingtalkcontact__1__0_models.TranslateFileHeaders()
        translate_file_headers.x_acs_dingtalk_access_token = '<your access token>'
        medias = {
            'key': 'xxxx'
        }
        translate_file_request = dingtalkcontact__1__0_models.TranslateFileRequest(
            medias=medias,
            output_file_name='Study Handbook',
            union_id='fXRUNxxx'
        )
        try:
            client.translate_file_with_options(translate_file_request, translate_file_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, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        translate_file_headers = dingtalkcontact__1__0_models.TranslateFileHeaders()
        translate_file_headers.x_acs_dingtalk_access_token = '<your access token>'
        medias = {
            'key': 'xxxx'
        }
        translate_file_request = dingtalkcontact__1__0_models.TranslateFileRequest(
            medias=medias,
            output_file_name='Study Handbook',
            union_id='fXRUNxxx'
        )
        try:
            await client.translate_file_with_options_async(translate_file_request, translate_file_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, which help locate the issue
                pass

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

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?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\TranslateFileHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\TranslateFileRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $translateFileHeaders = new TranslateFileHeaders([]);
        $translateFileHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $medias = [
            "key" => "xxxx"
        ];
        $translateFileRequest = new TranslateFileRequest([
            "medias" => $medias,
            "outputFileName" => "Study Handbook",
            "unionId" => "fXRUNxxx"
        ]);
        try {
            $client->translateFileWithOptions($translateFileRequest, $translateFileHeaders, 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, which 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));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 using 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
  }

  translateFileHeaders := &dingtalkcontact_1_0.TranslateFileHeaders{}
  translateFileHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  medias := map[string]*string{
    "key": tea.String("xxxx"),
  }
  translateFileRequest := &dingtalkcontact_1_0.TranslateFileRequest{
    Medias: medias,
    OutputFileName: tea.String("Study Handbook"),
    UnionId: tea.String("fXRUNxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.TranslateFileWithOptions(translateFileRequest, translateFileHeaders, &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, which help locate the issue
    }

  }
  return _err
}

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

Node.js

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 using 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 translateFileHeaders = new $dingtalkcontact_1_0.TranslateFileHeaders({ });
    translateFileHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let medias = {
      key: "xxxx",
    };
    let translateFileRequest = new $dingtalkcontact_1_0.TranslateFileRequest({
      medias: medias,
      outputFileName: "Study Handbook",
      unionId: "fXRUNxxx",
    });
    try {
      await client.translateFileWithOptions(translateFileRequest, translateFileHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains code and message attributes, which help locate the issue
      }

    }    
  }

}

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

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
// 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 using 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.TranslateFileHeaders translateFileHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileHeaders();
            translateFileHeaders.XAcsDingtalkAccessToken = "<your access token>";
            Dictionary<string, string> medias = new Dictionary<string, string>
            {
                {"key", "xxxx"},
            };
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileRequest translateFileRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.TranslateFileRequest
            {
                Medias = medias,
                OutputFileName = "Study Handbook",
                UnionId = "fXRUNxxx",
            };
            try
            {
                client.TranslateFileWithOptions(translateFileRequest, translateFileHeaders, 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, which 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, which help locate the issue
                }
            }
        }

    }
}
```

## Response

### Response body

| Name  | Type   | Description                                                                                                                                                                                                                                         |
| ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| jobId | String | The asynchronous translation job ID. Maximum length: 64 characters.    **jobId** is used as input for the [Obtain the results of an asynchronous translation task](/open/development/obtains-the-results-of-an-asynchronous-translation-task#) API. |

### Response body example

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "jobId" : "fXrgPrvsNxxx"
}
```

### Error codes

If an error is returned when calling this API, look up the error message in the [Global error codes](/open/development/server-api-error-codes-1) document for a solution.

| HttpCode | Error code    | Error message | Description       |
| -------- | ------------- | ------------- | ----------------- |
| 400      | param.invalid | %s            | Invalid parameter |
| 500      | system.busy   | System busy   | System busy       |