Get the result of an asynchronous translation job

Call this API to query the result of a translation job that has already been submitted.

API call description

API overview

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

Note

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

Call the Upload a file in a single step API to obtain the media_id.
Call the Asynchronously translate Contacts IDs API to obtain the translation job ID.

Note

After you call the Asynchronously translate Contacts IDs API, if the file is translated successfully, an asynchronous job callback notification is triggered. 4. Call this API to obtain the download link of the translated file.

Note

It is recommended that the returned file download link be referenced using an <a> tag. The download attribute must not be specified (due to browser compatibility issues). 5. The user downloads the file, the content of which is shown in the following example.

Request

Basic information

Field	Value
HTTP URL	https://api.dingtalk.io/v1.0/contact/files/translateResults
HTTP Method	GET
Supported app type	appType-Third-party enterprise app
Permissions	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 Get the access token of an organization authorized to a third-party app API.

Query parameters

Name	Type	Required	Description
jobId	String	Yes	The asynchronous translation job ID. Obtain the value of the `jobId` parameter by calling the Asynchronously translate Contacts IDs API.

Request example

HTTP

GET /v1.0/contact/files/translateResults?jobId=fXrgPrvsNiZNa8RWis9Nk1SY HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:BE6hsxxxx
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();
        GetTranslateFileJobResultHeaders getTranslateFileJobResultHeaders = new GetTranslateFileJobResultHeaders();
        getTranslateFileJobResultHeaders.xAcsDingtalkAccessToken = "<your access token>";
        GetTranslateFileJobResultRequest getTranslateFileJobResultRequest = new GetTranslateFileJobResultRequest()
                .setJobId("fXrgPrvsNiZNa8RWis9Nk1SY");
        try {
            client.getTranslateFileJobResultWithOptions(getTranslateFileJobResultRequest, getTranslateFileJobResultHeaders, 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 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 the code and message attributes, which 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()
        get_translate_file_job_result_headers = dingtalkcontact__1__0_models.GetTranslateFileJobResultHeaders()
        get_translate_file_job_result_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_translate_file_job_result_request = dingtalkcontact__1__0_models.GetTranslateFileJobResultRequest(
            job_id='fXrgPrvsNiZNa8RWis9Nk1SY'
        )
        try:
            client.get_translate_file_job_result_with_options(get_translate_file_job_result_request, get_translate_file_job_result_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 attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_translate_file_job_result_headers = dingtalkcontact__1__0_models.GetTranslateFileJobResultHeaders()
        get_translate_file_job_result_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_translate_file_job_result_request = dingtalkcontact__1__0_models.GetTranslateFileJobResultRequest(
            job_id='fXrgPrvsNiZNa8RWis9Nk1SY'
        )
        try:
            await client.get_translate_file_job_result_with_options_async(get_translate_file_job_result_request, get_translate_file_job_result_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 attributes, which 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\GetTranslateFileJobResultHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\GetTranslateFileJobResultRequest;
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();
        $getTranslateFileJobResultHeaders = new GetTranslateFileJobResultHeaders([]);
        $getTranslateFileJobResultHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getTranslateFileJobResultRequest = new GetTranslateFileJobResultRequest([
            "jobId" => "fXrgPrvsNiZNa8RWis9Nk1SY"
        ]);
        try {
            $client->getTranslateFileJobResultWithOptions($getTranslateFileJobResultRequest, $getTranslateFileJobResultHeaders, 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 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));

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

  getTranslateFileJobResultHeaders := &dingtalkcontact_1_0.GetTranslateFileJobResultHeaders{}
  getTranslateFileJobResultHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getTranslateFileJobResultRequest := &dingtalkcontact_1_0.GetTranslateFileJobResultRequest{
    JobId: tea.String("fXrgPrvsNiZNa8RWis9Nk1SY"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetTranslateFileJobResultWithOptions(getTranslateFileJobResultRequest, getTranslateFileJobResultHeaders, &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 attributes, which 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 getTranslateFileJobResultHeaders = new $dingtalkcontact_1_0.GetTranslateFileJobResultHeaders({ });
    getTranslateFileJobResultHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getTranslateFileJobResultRequest = new $dingtalkcontact_1_0.GetTranslateFileJobResultRequest({
      jobId: "fXrgPrvsNiZNa8RWis9Nk1SY",
    });
    try {
      await client.getTranslateFileJobResultWithOptions(getTranslateFileJobResultRequest, getTranslateFileJobResultHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which 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.GetTranslateFileJobResultHeaders getTranslateFileJobResultHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetTranslateFileJobResultHeaders();
            getTranslateFileJobResultHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetTranslateFileJobResultRequest getTranslateFileJobResultRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.GetTranslateFileJobResultRequest
            {
                JobId = "fXrgPrvsNiZNa8RWis9Nk1SY",
            };
            try
            {
                client.GetTranslateFileJobResultWithOptions(getTranslateFileJobResultRequest, getTranslateFileJobResultHeaders, 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 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 the code and message attributes, which 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::GetTranslateFileJobResultHeaders> getTranslateFileJobResultHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetTranslateFileJobResultHeaders>();
  getTranslateFileJobResultHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
  shared_ptr<Alibabacloud_Dingtalkcontact_1_0::GetTranslateFileJobResultRequest> getTranslateFileJobResultRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::GetTranslateFileJobResultRequest>(map<string, boost::any>({
    {"jobId", boost::any(string("fXrgPrvsNiZNa8RWis9Nk1SY"))}
  }));
  try {
    client->getTranslateFileJobResultWithOptions(getTranslateFileJobResultRequest, getTranslateFileJobResultHeaders, 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 attributes, which help locate the issue
    }
  }
}

Response

Response body

Name	Type	Description
status	String	The result of the translation job. Valid values: - 0: The job is in progress. - 1: The job has been processed successfully. - 2: The job processing failed.
url	String	The URL of the translated file content. The URL must be opened on the user side after OAuth 2.0 authorization.

Response body example

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

{
  "status" : "1",
  "url" : "xxxx"
}

Error codes

If an error is returned when you call 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	param.invalid	%s	Invalid parameter
500	system.busy	The system is busy.	The system is busy.

​API call description

​API overview

​Note

​Note

​Note

​Request

​Basic information

​Request header

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes

API call description

API overview

Note

Note

Note

Request

Basic information

Request header

Query parameters

Request example

Response

Response body

Response body example

Error codes