Skip to main content
Call this API to append a piece of text to the end of a paragraph.

API call description

For information about the data structures related to document content, see Document data structures.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/suites/documents/{docKey}/blocks/{blockId}/paragraph/appendText
HTTP MethodPOST
Supported app typeappType-Internal app
Required permissionspermission-Storage.File.Write-Write permission on organization storage files

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Path parameters

NameTypeRequiredDescription
docKeyStringYesThe document ID (the docKey or dentryUuid of the document). After you create a document by calling the Create a Knowledge Base document API, obtain the docKey parameter from the response. To get the dentryUuid from the document URL, take https://alidocs.dingtalk.io/i/nodes/Zxxxxa-id as an example; the dentryUuid is Zxxxxa-id.
blockIdStringYesThe unique identifier of the target paragraph. Obtain the blockId of the paragraph by calling the Query block elements API.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the user. Obtain the unionid value by calling the Query user details API.

Request body

NameTypeRequiredDescription
textStringYesThe text to insert.

Request example

HTTP
POST /v1.0/doc/suites/documents/doc_id/blocks/block_id/paragraph/appendText?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json

{
  "text" : "text"
}
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with 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.DocAppendTextHeaders docAppendTextHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocAppendTextHeaders();
        docAppendTextHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.DocAppendTextRequest docAppendTextRequest = new com.aliyun.dingtalkdoc_1_0.models.DocAppendTextRequest()
                .setOperatorId("union_id")
                .setText("text");
        try {
            client.docAppendTextWithOptions("doc_id", "block_id", docAppendTextRequest, docAppendTextHeaders, 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 contains code and message properties to help troubleshoot 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 code and message properties to help troubleshoot the issue
            }

        }        
    }
}
Python
# -*- 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 with 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()
        doc_append_text_headers = dingtalkdoc__1__0_models.DocAppendTextHeaders()
        doc_append_text_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_append_text_request = dingtalkdoc__1__0_models.DocAppendTextRequest(
            operator_id='union_id',
            text='text'
        )
        try:
            client.doc_append_text_with_options('doc_id', 'block_id', doc_append_text_request, doc_append_text_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help troubleshoot the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        doc_append_text_headers = dingtalkdoc__1__0_models.DocAppendTextHeaders()
        doc_append_text_headers.x_acs_dingtalk_access_token = '<your access token>'
        doc_append_text_request = dingtalkdoc__1__0_models.DocAppendTextRequest(
            operator_id='union_id',
            text='text'
        )
        try:
            await client.doc_append_text_with_options_async('doc_id', 'block_id', doc_append_text_request, doc_append_text_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message properties to help troubleshoot 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\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\DocAppendTextHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocAppendTextRequest;
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();
        $docAppendTextHeaders = new DocAppendTextHeaders([]);
        $docAppendTextHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $docAppendTextRequest = new DocAppendTextRequest([
            "operatorId" => "union_id",
            "text" => "text"
        ]);
        try {
            $client->docAppendTextWithOptions("doc_id", "block_id", $docAppendTextRequest, $docAppendTextHeaders, 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 code and message properties to help troubleshoot 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));
Go
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 with 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
  }

  docAppendTextHeaders := &dingtalkdoc_1_0.DocAppendTextHeaders{}
  docAppendTextHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  docAppendTextRequest := &dingtalkdoc_1_0.DocAppendTextRequest{
    OperatorId: tea.String("union_id"),
    Text: tea.String("text"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.DocAppendTextWithOptions(tea.String("doc_id"), tea.String("block_id"), docAppendTextRequest, docAppendTextHeaders, &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 code and message properties to help troubleshoot the issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
Node.js
'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 with 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 docAppendTextHeaders = new dingtalkdoc_1_0.DocAppendTextHeaders({ });
    docAppendTextHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let docAppendTextRequest = new dingtalkdoc_1_0.DocAppendTextRequest({
      operatorId: 'union_id',
      text: 'text',
    });
    try {
      await client.docAppendTextWithOptions('doc_id', 'block_id', docAppendTextRequest, docAppendTextHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties to help troubleshoot the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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 with 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.DocAppendTextHeaders docAppendTextHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocAppendTextHeaders();
            docAppendTextHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocAppendTextRequest docAppendTextRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocAppendTextRequest
            {
                OperatorId = "union_id",
                Text = "text",
            };
            try
            {
                client.DocAppendTextWithOptions("doc_id", "block_id", docAppendTextRequest, docAppendTextHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message properties to help troubleshoot 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 code and message properties to help troubleshoot the issue
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
successBooleanWhether the request succeeded.
resultObjectThe result of the request.
dataMap<String, Any>The content of the element after the text is appended.
AnyThe returned result.

Response body example

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

{
  "success" : true,
  "result" : {
    "data" : {
      "text" : "abctext"
    }
  }
}

Error codes

If an error is returned when you call this API, find the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
400invalidRequest.inputArgs.invalid%sParameter error. See the error message for details.
403forbidden.accessDenied%sNo permissions.
403forbidden.acrossOrg%sInvalid request. Check whether the target document belongs to the organization specified by the access token.
404docNotExist%sThe document does not exist.
404invalidRequest.resource.notFound%sThe requested resource cannot be found.
500forbidden.operationIllegal%sThe requested operation is illegal.
500systemError%sThe service is busy. Try again later.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sThe request timed out.