Deskripsi panggilan API
Lokasi penyisipan dapat berupachildren dari node root dokumen, atau children dari sebuah BlockElement yang mendukung penyisipan elemen blok (seperti blok sorot atau Tabel). Lokasi penyisipan ditentukan oleh parameter path dan index secara bersamaan.
Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/suites/documents/{documentId}/content |
| Metode HTTP | POST |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-Storage.File.Write-Izin tulis file penyimpanan organisasi |
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 aplikasi internal. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| documentId | String | Ya | ID Dokumen (docKey atau dentryUuid dokumen). Setelah membuat dokumen dengan memanggil API Membuat dokumen knowledge base, peroleh parameter docKey dari respons. Peroleh dentryUuid dari URL dokumen. Misalnya, pada https://docs.dingtalk.io/i/nodes/Zxxxxa-id, dentryUuid-nya adalah Zxxxxa-id. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId pengguna. Peroleh nilai parameter unionid dengan memanggil API Kueri detail pengguna. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| path | Array of Integer | Tidak | Lokasi penyisipan. |
| index | Integer | Tidak | Lokasi penyisipan. |
| content | Object | Ya | Konten yang akan disisipkan. |
| type | String | Ya | Tipe konten yang akan disisipkan. Saat ini hanya markdown yang didukung. |
| content | String | Ya | Teks konten yang akan disisipkan. |
Contoh permintaan
HTTPPOST /v1.0/doc/suites/documents/doc_id/content?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:access_token
Content-Type:application/json
{
"content" : {
"content" : "## Heading",
"type" : "markdown"
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using a Token</p>
* @return Client
*
* @throws Exception
*/
public static com.aliyun.dingtalkdoc_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.dingtalkdoc_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_1_0.models.InsertContentHeaders insertContentHeaders = new com.aliyun.dingtalkdoc_1_0.models.InsertContentHeaders();
insertContentHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.InsertContentRequest.InsertContentRequestContent content = new com.aliyun.dingtalkdoc_1_0.models.InsertContentRequest.InsertContentRequestContent()
.setContent("## Heading")
.setType("markdown");
com.aliyun.dingtalkdoc_1_0.models.InsertContentRequest insertContentRequest = new com.aliyun.dingtalkdoc_1_0.models.InsertContentRequest()
.setOperatorId("union_id")
.setPath(java.util.Arrays.asList(
0
))
.setContent(content);
try {
client.insertContentWithOptions("doc_id", insertContentRequest, insertContentHeaders, 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 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 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.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__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() -> dingtalkdoc_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 dingtalkdoc_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
insert_content_headers = dingtalkdoc__1__0_models.InsertContentHeaders()
insert_content_headers.x_acs_dingtalk_access_token = '<your access token>'
content = dingtalkdoc__1__0_models.InsertContentRequestContent(
content='## Heading',
type='markdown'
)
insert_content_request = dingtalkdoc__1__0_models.InsertContentRequest(
operator_id='union_id',
path=[
0
],
content=content
)
try:
client.insert_content_with_options('doc_id', insert_content_request, insert_content_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 issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
insert_content_headers = dingtalkdoc__1__0_models.InsertContentHeaders()
insert_content_headers.x_acs_dingtalk_access_token = '<your access token>'
content = dingtalkdoc__1__0_models.InsertContentRequestContent(
content='## Heading',
type='markdown'
)
insert_content_request = dingtalkdoc__1__0_models.InsertContentRequest(
operator_id='union_id',
path=[
0
],
content=content
)
try:
await client.insert_content_with_options_async('doc_id', insert_content_request, insert_content_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 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\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\InsertContentHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\InsertContentRequest\content;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\InsertContentRequest;
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();
$insertContentHeaders = new InsertContentHeaders([]);
$insertContentHeaders->xAcsDingtalkAccessToken = "<your access token>";
$content = new content([
"content" => "## Heading",
"type" => "markdown"
]);
$insertContentRequest = new InsertContentRequest([
"operatorId" => "union_id",
"path" => [
0
],
"content" => $content
]);
try {
$client->insertContentWithOptions("doc_id", $insertContentRequest, $insertContentHeaders, 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 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"
dingtalkdoc_1_0 "github.com/alibabacloud-go/dingtalk/doc_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
// Description:
//
// Initialize the account Client using a Token
//
// @return Client
//
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkdoc_1_0.Client{}
_result, _err = dingtalkdoc_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
insertContentHeaders := &dingtalkdoc_1_0.InsertContentHeaders{}
insertContentHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
content := &dingtalkdoc_1_0.InsertContentRequestContent{
Content: tea.String("## Heading"),
Type: tea.String("markdown"),
}
insertContentRequest := &dingtalkdoc_1_0.InsertContentRequest{
OperatorId: tea.String("union_id"),
Path: []*int32{tea.Int32(0)},
Content: content,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.InsertContentWithOptions(tea.String("doc_id"), insertContentRequest, insertContentHeaders, &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 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 dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');
class Client {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
static createClient() {
let config = new OpenApi.Config({ });
config.protocol = 'https';
config.regionId = 'central';
return new dingtalkdoc_1_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let insertContentHeaders = new dingtalkdoc_1_0.InsertContentHeaders({ });
insertContentHeaders.xAcsDingtalkAccessToken = '<your access token>';
let content = new dingtalkdoc_1_0.InsertContentRequestContent({
content: '## Heading',
type: 'markdown',
});
let insertContentRequest = new dingtalkdoc_1_0.InsertContentRequest({
operatorId: 'union_id',
path: [
0
],
content: content,
});
try {
await client.insertContentWithOptions('doc_id', insertContentRequest, insertContentHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err berisi atribut code dan message yang membantu 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 a Token</para>
/// </description>
///
/// <returns>
/// Client
/// </returns>
///
/// <term><b>Exception:</b></term>
/// Exception
public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentHeaders insertContentHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentHeaders();
insertContentHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentRequest.InsertContentRequestContent content = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentRequest.InsertContentRequestContent
{
Content = "## Heading",
Type = "markdown",
};
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentRequest insertContentRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.InsertContentRequest
{
OperatorId = "union_id",
Path = new List<int?>
{
0
},
Content = content,
};
try
{
client.InsertContentWithOptions("doc_id", insertContentRequest, insertContentHeaders, 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 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 menemukan issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| success | Boolean | Apakah permintaan berhasil. |
| result | Map | Hasil permintaan. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Kode error
Jika terjadi error saat memanggil API ini, lihat dokumen Kode error global untuk menemukan solusi berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter. |
| 400 | invalidRequest.inputArgs.invalid | %s | Error parameter. Lihat pesan error untuk detailnya. |
| 403 | forbidden.accessDenied | %s | Tidak ada izin. |
| 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Pastikan dokumen yang diakses milik organisasi yang ditentukan oleh access token. |
| 404 | docNotExist | %s | Dokumen tidak ada. |
| 404 | invalidRequest.resource.notFound | %s | Resource yang diminta tidak dapat ditemukan. |
| 500 | forbidden.operationIllegal | %s | Tindakan yang diminta tidak valid. |
| 500 | systemError | %s | Layanan sedang sibuk. Silakan coba lagi nanti. |
| 500 | unknownError | Unknown Error | Error tidak dikenal. |
| 503 | operationTimeout | %s | Permintaan melebihi waktu tunggu. |