Menerjemahkan ID Kontak secara asinkron
Deskripsi panggilan API
- Susun dokumen yang akan diterjemahkan, seperti ditunjukkan pada gambar berikut.
Catatan
Hanya file dengan format xlsx, xls, csv, dan txt yang didukung.- Panggil API Unggah file satu langkah untuk memperoleh media_id.
- Panggil API ini untuk memperoleh ID job terjemahan.
Catatan
Setelah API ini dipanggil, jika file berhasil diterjemahkan, notifikasi callback job asinkron akan terpicu. 4. Panggil API Memperoleh hasil tugas terjemahan asinkron untuk memperoleh tautan unduh file yang telah diterjemahkan.Catatan
Disarankan untuk mereferensikan tautan unduh file yang dikembalikan dengan<a> tag. Jangan tentukan atribut download (karena masalah kompatibilitas browser).
5. Konten file yang diunduh oleh pengguna ditunjukkan pada gambar berikut.
Saat memanggil API ini, Anda mungkin menemui masalah berikut:
- Issue: File
excelyang dihasilkan dengan pustaka pihak ketigaNodeJsyaituexceljsterlihat baik-baik saja dari sisi konten, tetapi terjemahannya gagal. - Penyebab: Ketika
sharedStringtidak diaktifkan,exceljssecara default menulis konten file menggunakanformula string. Perilaku ini tidak standar dan menyebabkan terjemahan gagal. - Solusi: Rujuk dokumentasi
exceljsdan paksa-aktifkan opsiuseSharedStrings.
Permintaan
Informasi dasar
| Bidang | Value |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/contact/files/translate |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi perusahaan pihak ketiga |
| Persyaratan izin | permission-qyapi_get_member-Izin baca informasi pengguna |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Peroleh dengan memanggil API Memperoleh access token perusahaan yang diberikan otorisasi ke aplikasi pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| medias | Map<String, String> | Ya | Informasi tentang file yang akan diterjemahkan. - Tipe Map. Key adalah media_id file Drive, yang diperoleh dengan memanggil API Memperoleh informasi unggah file. - Value adalah nama file, yang harus menyertakan ekstensi file dan konsisten dengan nama file yang dikirim saat memanggil API Memperoleh informasi unggah file. - Hanya file dengan format xlsx, xls, csv, dan txt yang didukung. - Maksimal 20 file. |
| outputFileName | String | Tidak | Nama file terpaket setelah terjemahan. Jangan sertakan ekstensi file. Parameter ini wajib jika lebih dari satu file ditentukan dalam medias. |
| unionId | String | Ya | unionId pengguna yang saat ini mengekspor dokumen. Peroleh dengan memanggil API Memperoleh informasi pengguna dengan kode login senyap. |
Contoh permintaan
HTTPPOST /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" : "Buku Panduan Studi",
"unionId" : "fXRUNxxx"
}
// 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("Buku Panduan Studi")
.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 berisi atribut code dan message, yang membantu menemukan masalah
}
} 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 menemukan masalah
}
}
}
}
# -*- 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='Buku Panduan Studi',
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 berisi atribut code dan message, yang membantu menemukan masalah
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='Buku Panduan Studi',
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 berisi atribut code dan message, yang membantu menemukan masalah
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\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" => "Buku Panduan Studi",
"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 berisi atribut code dan message, yang membantu menemukan masalah
}
}
}
}
$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 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("Buku Panduan Studi"),
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 berisi atribut code dan message, yang membantu menemukan masalah
}
}
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 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: "Buku Panduan Studi",
unionId: "fXRUNxxx",
});
try {
await client.translateFileWithOptions(translateFileRequest, translateFileHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message, yang membantu menemukan masalah
}
}
}
}
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 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 = "Buku Panduan Studi",
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 berisi atribut code dan message, yang membantu menemukan masalah
}
}
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 menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| jobId | String | ID job terjemahan asinkron. Panjang maksimum: 64 karakter. jobId digunakan sebagai input untuk API Memperoleh hasil tugas terjemahan asinkron. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"jobId" : "fXrgPrvsNxxx"
}
Kode error
Jika error dikembalikan saat memanggil API ini, cari pesan error dalam dokumen Kode error global untuk mendapatkan solusinya.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | param.invalid | %s | Parameter tidak valid |
| 500 | system.busy | System busy | Sistem sibuk |