Deskripsi panggilan API
Untuk mempelajari struktur data yang terkait dengan konten dokumen, lihat Struktur data dokumen.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/suites/documents/{docKey}/blocks |
| 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. Dapatkan dengan memanggil API Memperoleh access token aplikasi internal. |
Parameter jalur
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| docKey | String | Ya | ID dokumen (docKey atau dentryUuid dari dokumen). Setelah membuat dokumen dengan memanggil API Membuat dokumen Knowledge Base, dapatkan parameter docKey dari respons. Untuk memperoleh dentryUuid dari URL dokumen, ambil contoh https://docs.dingtalk.io/i/nodes/Zxxxxa-id. dentryUuid-nya adalah Zxxxxa-id. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| operatorId | String | Ya | unionId pengguna. Dapatkan parameter unionid dengan memanggil API Mengueri detail pengguna. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| blockId | String | Tidak | Identifier unik dari block target. Dapatkan parameter blockId dengan memanggil API Mengueri elemen block. Jika tidak ditentukan, nilai index yang digunakan. |
| index | Integer | Tidak | Ketika blockId tidak diberikan, index digunakan untuk menentukan lokasi block target. Sistem mencoba menemukan block pada posisi index di antara elemen block tingkat pertama dokumen, dengan index dimulai dari 0. Jika tidak ditentukan, akhir dokumen digunakan secara default. |
| where | String | Tidak | Apakah menyisipkan sebelum atau sesudah lokasi target. Nilai yang valid: - after: Sisipkan setelah lokasi target. Ini adalah nilai default. - before: Sisipkan sebelum lokasi target. |
| element | Map<String, Any> | Ya | Tipe BlockElement yang akan disisipkan dan atribut yang diperlukan untuk membuat tipe terkait (lihat Struktur data elemen block untuk detailnya). Strukturnya adalah sebagai berikut: { "blockType": enum(BlockType), [blockType]: Object(CreateElementProperties), } |
| Any | Tidak | Berisi tipe elemen dan informasi yang diperlukan untuk membuat elemen. |
Contoh permintaan
HTTPPOST /v1.0/doc/suites/documents/doc_id/blocks?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json
{
"blockId" : "block_id",
"index" : 1,
"where" : "after",
"element" : {
"blockType" : "paragraph",
"paragraph" : {
"text" : "foo"
}
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client using 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.DocInsertBlocksHeaders docInsertBlocksHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocInsertBlocksHeaders();
docInsertBlocksHeaders.xAcsDingtalkAccessToken = "<your access token>";
java.util.Map<String, java.util.Map<String, Object>> element = TeaConverter.buildMap(
new TeaPair("key", new java.util.HashMap<>())
);
com.aliyun.dingtalkdoc_1_0.models.DocInsertBlocksRequest docInsertBlocksRequest = new com.aliyun.dingtalkdoc_1_0.models.DocInsertBlocksRequest()
.setOperatorId("union_id")
.setBlockId("block_id")
.setIndex(1)
.setWhere("after")
.setElement(element);
try {
client.docInsertBlocksWithOptions("doc_id", docInsertBlocksRequest, docInsertBlocksHeaders, 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 dapat membantu developer menemukan sumber 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 dapat membantu developer menemukan sumber masalah
}
}
}
}
# -*- 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 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()
doc_insert_blocks_headers = dingtalkdoc__1__0_models.DocInsertBlocksHeaders()
doc_insert_blocks_headers.x_acs_dingtalk_access_token = '<your access token>'
element = {
'key': {}
}
doc_insert_blocks_request = dingtalkdoc__1__0_models.DocInsertBlocksRequest(
operator_id='union_id',
block_id='block_id',
index=1,
where='after',
element=element
)
try:
client.doc_insert_blocks_with_options('doc_id', doc_insert_blocks_request, doc_insert_blocks_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 dapat membantu developer menemukan sumber masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
doc_insert_blocks_headers = dingtalkdoc__1__0_models.DocInsertBlocksHeaders()
doc_insert_blocks_headers.x_acs_dingtalk_access_token = '<your access token>'
element = {
'key': {}
}
doc_insert_blocks_request = dingtalkdoc__1__0_models.DocInsertBlocksRequest(
operator_id='union_id',
block_id='block_id',
index=1,
where='after',
element=element
)
try:
await client.doc_insert_blocks_with_options_async('doc_id', doc_insert_blocks_request, doc_insert_blocks_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 dapat membantu developer menemukan sumber 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\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\DocInsertBlocksHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocInsertBlocksRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$docInsertBlocksHeaders = new DocInsertBlocksHeaders([]);
$docInsertBlocksHeaders->xAcsDingtalkAccessToken = "<your access token>";
$element = [
"key" => []
];
$docInsertBlocksRequest = new DocInsertBlocksRequest([
"operatorId" => "union_id",
"blockId" => "block_id",
"index" => 1,
"where" => "after",
"element" => $element
]);
try {
$client->docInsertBlocksWithOptions("doc_id", $docInsertBlocksRequest, $docInsertBlocksHeaders, 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 dapat membantu developer menemukan sumber 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));
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 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
}
docInsertBlocksHeaders := &dingtalkdoc_1_0.DocInsertBlocksHeaders{}
docInsertBlocksHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
element := map[string]map[string]interface{}{
"key": map[string]interface{}{},
}
docInsertBlocksRequest := &dingtalkdoc_1_0.DocInsertBlocksRequest{
OperatorId: tea.String("union_id"),
BlockId: tea.String("block_id"),
Index: tea.Int32(1),
Where: tea.String("after"),
Element: element,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.DocInsertBlocksWithOptions(tea.String("doc_id"), docInsertBlocksRequest, docInsertBlocksHeaders, &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 dapat membantu developer menemukan sumber masalah
}
}
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 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 docInsertBlocksHeaders = new dingtalkdoc_1_0.DocInsertBlocksHeaders({ });
docInsertBlocksHeaders.xAcsDingtalkAccessToken = '<your access token>';
let element = {
key: { },
};
let docInsertBlocksRequest = new dingtalkdoc_1_0.DocInsertBlocksRequest({
operatorId: 'union_id',
blockId: 'block_id',
index: 1,
where: 'after',
element: element,
});
try {
await client.docInsertBlocksWithOptions('doc_id', docInsertBlocksRequest, docInsertBlocksHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err berisi Atribut code dan message, yang dapat membantu developer menemukan sumber masalah
}
}
}
}
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 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.DocInsertBlocksHeaders docInsertBlocksHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocInsertBlocksHeaders();
docInsertBlocksHeaders.XAcsDingtalkAccessToken = "<your access token>";
Dictionary<string, Dictionary<string, object>> element = new Dictionary<string, Dictionary<string, object>>
{
{"key", new Dictionary<string, object>(){}},
};
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocInsertBlocksRequest docInsertBlocksRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocInsertBlocksRequest
{
OperatorId = "union_id",
BlockId = "block_id",
Index = 1,
Where = "after",
Element = element,
};
try
{
client.DocInsertBlocksWithOptions("doc_id", docInsertBlocksRequest, docInsertBlocksHeaders, 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 dapat membantu developer menemukan sumber 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 dapat membantu developer menemukan sumber masalah
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| success | Boolean | Apakah permintaan berhasil. |
| result | Object | Hasil permintaan. |
| data | Map<String, Any> | Elemen yang disisipkan. |
| Any | Detail tentang elemen. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"success": true,
"result": {
"data": {
"blockType": "paragraph",
"paragraph": {
"text": "foo"
},
"id": "lmoasis2f3wxmwyyyy",
"index": 2,
}
}
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumentasi Kode error global 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. Periksa apakah dokumen yang Anda coba akses milik organisasi yang ditentukan oleh access token. |
| 404 | docNotExist | %s | Dokumen tidak ada. |
| 404 | invalidRequest.resource.notFound | %s | Sumber daya yang diminta tidak dapat ditemukan. |
| 500 | forbidden.operationIllegal | %s | Operasi yang diminta tidak valid. |
| 500 | systemError | %s | Layanan sedang sibuk. Coba lagi nanti. |
| 500 | unknownError | Unknown Error | Error tidak diketahui. |
| 503 | operationTimeout | %s | Permintaan habis waktu. |