コンテンツを挿入する

このインターフェースを呼び出すことで、ドキュメントの指定位置に一段落のコンテンツを挿入します。コンテンツタイプは Markdown をサポートします。

API 呼び出し説明

挿入位置は、ドキュメントのルートノードの children、またはブロック要素の挿入をサポートする BlockElement（ハイライトブロックや Table など）の children を指定できます。path パラメータと index パラメータを組み合わせて挿入位置を決定します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/suites/documents/{documentId}/content`
HTTP Method	POST
サポートするアプリタイプ	appType-社内アプリ
権限要件	permission-Storage.File.Write-企業ストレージファイル書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	このインターフェース呼び出しのアクセス認証情報。社内アプリのアクセストークンを取得するインターフェースを呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
documentId	String	はい	ドキュメント ID（ドキュメントの docKey または dentryUuid）。ナレッジベースドキュメントを作成するインターフェースでドキュメントを作成し、戻り値から `docKey` パラメータを取得します。ドキュメント URL から `dentryUuid` を取得します。例えば https://docs.dingtalk.io/i/nodes/Zxxxxa-id の場合、dentryUuid は Zxxxxa-id です。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	はい	ユーザーの unionId。ユーザー詳細を照会するインターフェースから unionid パラメータの値を取得できます。

リクエストボディ

名前	タイプ	必須	説明
path	Array of Integer	いいえ	挿入位置。
index	Integer	いいえ	挿入位置。
content	Object	はい	挿入するコンテンツ。
type	String	はい	挿入するコンテンツの具体的なタイプ。現在は `markdown` のみサポートしています。
content	String	はい	挿入するコンテンツのテキスト。

リクエスト例

HTTP

POST /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"
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        } 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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }

        }        
    }
}

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:
        """
        Token を使用してアカウント Client を初期化します
        @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                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\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 {

    /**
     * Token を使用してアカウント Client を初期化します
     * @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
            }
        }
    }
}
$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:
// 
// Token を使用してアカウント Client を初期化します
// 
// @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
    }

  }
  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 {

  /**
   * Token を使用してアカウント Client を初期化します
   * @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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
      }

    }    
  }

}

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>Token を使用してアカウント Client を初期化します</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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
            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 には code と message 属性が含まれており、開発者の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
success	Boolean	リクエストが成功したかどうか。
result	Map	リクエスト結果。

レスポンスボディの例

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

{
  "success" : true
}

エラーコード

このインターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	paramError	%s	パラメータエラー
400	invalidRequest.inputArgs.invalid	%s	パラメータエラー。エラーメッセージを確認してください。
403	forbidden.accessDenied	%s	権限がありません
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセスしようとしているドキュメントが accessToken で指定された組織に所属しているかご確認ください。
404	docNotExist	%s	ドキュメントが存在しません
404	invalidRequest.resource.notFound	%s	アクセスしようとしているリソースが見つかりません
500	forbidden.operationIllegal	%s	リクエストされた操作が不正です
500	systemError	%s	サービスが混み合っています。後で再試行してください
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストがタイムアウトしました

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディの例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード