Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/convFile/conversations/files/links/send |
| Metode HTTP | POST |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang wajib | permission-ConvFile.File.Send-Izin pengiriman file grup |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan memanggil API Dapatkan access token aplikasi internal. |
Parameter query
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Dapatkan dengan memanggil API Kueri detail pengguna. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| spaceId | String | Ya | ID ruang tempat file berada. Dapatkan dengan memanggil API Tambah ruang. |
| dentryId | String | Ya | ID file. Dapatkan nilai parameter id dengan memanggil API Dapatkan daftar file atau folder. |
| openConversationId | String | Ya | openConversationId dari obrolan target. Dapatkan nilai parameter openConversationId dengan memanggil API Buat grup. |
Contoh permintaan
HTTPPOST /v1.0/convFile/conversations/files/links/send?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"spaceId" : "786xxxxx",
"dentryId" : "908xxxxx",
"openConversationId" : "cidCxxxxx"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkconv_file_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.dingtalkconv_file_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkconv_file_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkconv_file_1_0.models.SendLinkHeaders sendLinkHeaders = new com.aliyun.dingtalkconv_file_1_0.models.SendLinkHeaders();
sendLinkHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkconv_file_1_0.models.SendLinkRequest sendLinkRequest = new com.aliyun.dingtalkconv_file_1_0.models.SendLinkRequest()
.setUnionId("chyxxxxx")
.setSpaceId("786xxxxx")
.setDentryId("908xxxxx")
.setOpenConversationId("cidCxxxxx");
try {
client.sendLinkWithOptions(sendLinkRequest, sendLinkHeaders, 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 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 developer menemukan masalah
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.convFile_1_0.client import Client as dingtalkconvFile_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.convFile_1_0 import models as dingtalkconv_file__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() -> dingtalkconvFile_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 dingtalkconvFile_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
send_link_headers = dingtalkconv_file__1__0_models.SendLinkHeaders()
send_link_headers.x_acs_dingtalk_access_token = '<your access token>'
send_link_request = dingtalkconv_file__1__0_models.SendLinkRequest(
union_id='chyxxxxx',
space_id='786xxxxx',
dentry_id='908xxxxx',
open_conversation_id='cidCxxxxx'
)
try:
client.send_link_with_options(send_link_request, send_link_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 masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
send_link_headers = dingtalkconv_file__1__0_models.SendLinkHeaders()
send_link_headers.x_acs_dingtalk_access_token = '<your access token>'
send_link_request = dingtalkconv_file__1__0_models.SendLinkRequest(
union_id='chyxxxxx',
space_id='786xxxxx',
dentry_id='908xxxxx',
open_conversation_id='cidCxxxxx'
)
try:
await client.send_link_with_options_async(send_link_request, send_link_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 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\Vconv_file_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendLinkHeaders;
use AlibabaCloud\SDK\Dingtalk\Vconv_file_1_0\Models\SendLinkRequest;
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();
$sendLinkHeaders = new SendLinkHeaders([]);
$sendLinkHeaders->xAcsDingtalkAccessToken = "<your access token>";
$sendLinkRequest = new SendLinkRequest([
"unionId" => "chyxxxxx",
"spaceId" => "786xxxxx",
"dentryId" => "908xxxxx",
"openConversationId" => "cidCxxxxx"
]);
try {
$client->sendLinkWithOptions($sendLinkRequest, $sendLinkHeaders, 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 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/v2/service"
dingtalkconvfile_1_0 "github.com/alibabacloud-go/dingtalk/convFile_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkconvfile_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkconvfile_1_0.Client{}
_result, _err = dingtalkconvfile_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
sendLinkHeaders := &dingtalkconvfile_1_0.SendLinkHeaders{}
sendLinkHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
sendLinkRequest := &dingtalkconvfile_1_0.SendLinkRequest{
UnionId: tea.String("chyxxxxx"),
SpaceId: tea.String("786xxxxx"),
DentryId: tea.String("908xxxxx"),
OpenConversationId: tea.String("cidCxxxxx"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SendLinkWithOptions(sendLinkRequest, sendLinkHeaders, &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 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 dingtalkconvFile_1_0, * as $dingtalkconvFile_1_0 from '@alicloud/dingtalk/convFile_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(): dingtalkconvFile_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkconvFile_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let sendLinkHeaders = new $dingtalkconvFile_1_0.SendLinkHeaders({ });
sendLinkHeaders.xAcsDingtalkAccessToken = "<your access token>";
let sendLinkRequest = new $dingtalkconvFile_1_0.SendLinkRequest({
unionId: "chyxxxxx",
spaceId: "786xxxxx",
dentryId: "908xxxxx",
openConversationId: "cidCxxxxx",
});
try {
await client.sendLinkWithOptions(sendLinkRequest, sendLinkHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message yang membantu developer 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.Dingtalkconv_file_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkHeaders sendLinkHeaders = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkHeaders();
sendLinkHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkRequest sendLinkRequest = new AlibabaCloud.SDK.Dingtalkconv_file_1_0.Models.SendLinkRequest
{
UnionId = "chyxxxxx",
SpaceId = "786xxxxx",
DentryId = "908xxxxx",
OpenConversationId = "cidCxxxxx",
};
try
{
client.SendLinkWithOptions(sendLinkRequest, sendLinkHeaders, 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 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 developer menemukan masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| file | Object | Informasi tautan file yang dikirim ke obrolan target. |
| id | String | ID file. |
| conversationId | String | openConversationId dari obrolan tempat file berada. |
| spaceId | String | ID ruang tempat file berada. |
| parentId | String | ID folder induk tempat file berada. ID folder root adalah 0. |
| type | String | Tipe file. - FILE: file - FOLDER: folder |
| name | String | Nama file. |
| size | Long | Ukuran file, dalam byte. |
| path | String | Jalur file. |
| version | Long | Nomor versi file. |
| status | String | Status file. - NORMAL: normal - DELETED: dihapus - EXPIRED: kedaluwarsa |
| extension | String | Ekstensi file. |
| creatorId | String | unionId pembuat file. |
| modifierId | String | unionId pemodifikasi file. |
| createTime | String | Waktu file dibuat, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| modifiedTime | String | Waktu file terakhir diubah, dalam format ISO 8601. Contoh: 2022-07-29T14:55Z. |
| uuid | String | Bidang identifier. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"file" : {
"id" : "file_id",
"conversationId" : "open_conversation_id",
"spaceId" : "space_id",
"parentId" : "parent_id",
"type" : "file",
"name" : "file_name",
"size" : 256,
"path" : "file_path",
"version" : 1,
"status" : "NORMAL",
"extension" : "txt",
"creatorId" : "creator_id",
"modifierId" : "modified_id",
"createTime" : "2022-01-01T10:00:00Z",
"modifiedTime" : "2022-01-01T10:00:00Z",
"uuid" : "uuid"
}
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter |
| 400 | paramError.spaceId | %s | Error parameter - spaceId |
| 400 | paramError.dentryId | %s | Error parameter - dentryId |
| 400 | paramError.conversationId | %s | Error parameter - conversationId |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk menambahkan file ke ruang penyimpanan obrolan target |
| 404 | conversationNotExist | %s | Obrolan target tidak ada |
| 500 | systemError | %s | Error sistem |
| 500 | unknownError | Unknown Error | Error tidak diketahui |