API 呼び出し説明
ドキュメントコンテンツに関するデータ構造の詳細は、ドキュメントデータ構造 を参照してください。リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/suites/documents/{docKey}/blocks |
| HTTP Method | GET |
| サポートされるアプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-Storage.File.Read-企業ストレージファイル読み取り権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | この API を呼び出すためのアクセス認証情報。社内アプリの access_token を取得 API を呼び出して取得します。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| docKey | String | はい | ドキュメント ID(ドキュメントの docKey または dentryUuid)。ナレッジベースドキュメントの作成 API を呼び出してドキュメントを作成した後、戻り値から docKey パラメータを取得します。 dentryUuid はドキュメント URL から取得します。例えば https://docs.dingtalk.io/i/nodes/Zxxxxa-id の場合、dentryUuid は Zxxxxa-id です。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| startIndex | Integer | いいえ | 開始位置。0 以上の整数で、ドキュメント配下の第 startIndex 番目のブロック要素から開始することを示します。 |
| endIndex | Integer | いいえ | 終了位置。0 以上の整数で、第 endIndex 番目のブロック要素までクエリすることを示します。 |
| blockType | String | いいえ | 指定するブロック要素タイプ。詳細は ブロック要素データ構造 を参照してください。 |
| operatorId | String | はい | ユーザーの unionId。ユーザー詳細のクエリ API を呼び出して unionid パラメータの値を取得できます。 |
リクエスト例
HTTPGET /v1.0/doc/suites/documents/doc_id/blocks?startIndex=0&endIndex=1&blockType=paragraph&operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:7dc9ec4xxx
Content-Type:application/json
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.DocBlocksQueryHeaders docBlocksQueryHeaders = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksQueryHeaders();
docBlocksQueryHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.DocBlocksQueryRequest docBlocksQueryRequest = new com.aliyun.dingtalkdoc_1_0.models.DocBlocksQueryRequest()
.setStartIndex(0)
.setEndIndex(1)
.setBlockType("paragraph")
.setOperatorId("union_id");
try {
client.docBlocksQueryWithOptions("doc_id", docBlocksQueryRequest, docBlocksQueryHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
}
}
}
}
# -*- 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()
doc_blocks_query_headers = dingtalkdoc__1__0_models.DocBlocksQueryHeaders()
doc_blocks_query_headers.x_acs_dingtalk_access_token = '<your access token>'
doc_blocks_query_request = dingtalkdoc__1__0_models.DocBlocksQueryRequest(
start_index=0,
end_index=1,
block_type='paragraph',
operator_id='union_id'
)
try:
client.doc_blocks_query_with_options('doc_id', doc_blocks_query_request, doc_blocks_query_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()
doc_blocks_query_headers = dingtalkdoc__1__0_models.DocBlocksQueryHeaders()
doc_blocks_query_headers.x_acs_dingtalk_access_token = '<your access token>'
doc_blocks_query_request = dingtalkdoc__1__0_models.DocBlocksQueryRequest(
start_index=0,
end_index=1,
block_type='paragraph',
operator_id='union_id'
)
try:
await client.doc_blocks_query_with_options_async('doc_id', doc_blocks_query_request, doc_blocks_query_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
// 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\DocBlocksQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocBlocksQueryRequest;
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();
$docBlocksQueryHeaders = new DocBlocksQueryHeaders([]);
$docBlocksQueryHeaders->xAcsDingtalkAccessToken = "<your access token>";
$docBlocksQueryRequest = new DocBlocksQueryRequest([
"startIndex" => 0,
"endIndex" => 1,
"blockType" => "paragraph",
"operatorId" => "union_id"
]);
try {
$client->docBlocksQueryWithOptions("doc_id", $docBlocksQueryRequest, $docBlocksQueryHeaders, 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
}
docBlocksQueryHeaders := &dingtalkdoc_1_0.DocBlocksQueryHeaders{}
docBlocksQueryHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
docBlocksQueryRequest := &dingtalkdoc_1_0.DocBlocksQueryRequest{
StartIndex: tea.Int32(0),
EndIndex: tea.Int32(1),
BlockType: tea.String("paragraph"),
OperatorId: tea.String("union_id"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.DocBlocksQueryWithOptions(tea.String("doc_id"), docBlocksQueryRequest, docBlocksQueryHeaders, &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)
}
}
'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 docBlocksQueryHeaders = new dingtalkdoc_1_0.DocBlocksQueryHeaders({ });
docBlocksQueryHeaders.xAcsDingtalkAccessToken = '<your access token>';
let docBlocksQueryRequest = new dingtalkdoc_1_0.DocBlocksQueryRequest({
startIndex: 0,
endIndex: 1,
blockType: 'paragraph',
operatorId: 'union_id',
});
try {
await client.docBlocksQueryWithOptions('doc_id', docBlocksQueryRequest, docBlocksQueryHeaders, 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.DocBlocksQueryHeaders docBlocksQueryHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksQueryHeaders();
docBlocksQueryHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksQueryRequest docBlocksQueryRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.DocBlocksQueryRequest
{
StartIndex = 0,
EndIndex = 1,
BlockType = "paragraph",
OperatorId = "union_id",
};
try
{
client.DocBlocksQueryWithOptions("doc_id", docBlocksQueryRequest, docBlocksQueryHeaders, 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 | Object | リクエスト結果。 |
| data | Array of Any | 各要素はブロック要素の構造です。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"success": true,
"result": {
"data": [
{
"blockType": "paragraph",
"paragraph": {
"text": "段落1"
},
"id": "lc4si5p3n84zwqxxx",
"index": 1,
},
{
"blockType": "paragraph",
"paragraph": {
"text": "段落2"
},
"id": "lc4si5p3n84zwqyyy",
"index": 1,
}
]
},
}
エラーコード
この API の呼び出しでエラーが発生した場合、エラーメッセージをもとに グローバルエラーコード ドキュメントで解決方法を検索してください。| 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 | リクエストがタイムアウトしました |