Deskripsi panggilan API
Untuk detail tentang 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 | GET |
| Jenis aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang wajib | permission-Storage.File.Read-Izin baca untuk file penyimpanan organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Dapatkan dengan memanggil API Mendapatkan access token aplikasi internal. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| docKey | String | Ya | ID Dokumen (docKey atau dentryUuid dari dokumen). Setelah Anda membuat dokumen dengan memanggil API Membuat dokumen Knowledge Base, dapatkan docKey dari respons. Alternatifnya, dapatkan dentryUuid dari URL dokumen. Sebagai contoh, pada https://docs.dingtalk.io/i/nodes/Zxxxxa-id, dentryUuid adalah Zxxxxa-id. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| startIndex | Integer | Tidak | Posisi awal. Sebuah integer yang lebih besar dari atau sama dengan 0, yang menunjukkan bahwa kueri dimulai dari elemen block ke-startIndex di bawah dokumen. |
| endIndex | Integer | Tidak | Posisi akhir. Sebuah integer yang lebih besar dari atau sama dengan 0, yang menunjukkan bahwa kueri berakhir pada elemen block ke-endIndex. |
| blockType | String | Tidak | Tipe elemen block yang ditentukan. Untuk detailnya, lihat Struktur data elemen block. |
| operatorId | String | Ya | unionId dari pengguna. Dapatkan nilai parameter unionid dengan memanggil API Mengueri detail pengguna. |
Contoh permintaan
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>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.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 berisi atribut code dan message, yang membantu menemukan lokasi 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 lokasi 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 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_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 berisi atribut code dan message, yang membantu menemukan lokasi issue
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 berisi atribut code dan message, yang membantu menemukan lokasi 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\DocBlocksQueryHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\DocBlocksQueryRequest;
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();
$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 berisi atribut code dan message, yang membantu menemukan lokasi 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 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
}
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 berisi atribut code dan message, yang membantu menemukan lokasi 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 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 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 berisi atribut code dan message, yang membantu menemukan lokasi 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 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.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 berisi atribut code dan message, yang membantu menemukan lokasi 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 lokasi issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| success | Boolean | Apakah permintaan berhasil. |
| result | Object | Hasil dari permintaan. |
| data | Array of Any | Setiap item adalah struktur elemen block. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"success": true,
"result": {
"data": [
{
"blockType": "paragraph",
"paragraph": {
"text": "Paragraf 1"
},
"id": "lc4si5p3n84zwqxxx",
"index": 1,
},
{
"blockType": "paragraph",
"paragraph": {
"text": "Paragraf 2"
},
"id": "lc4si5p3n84zwqyyy",
"index": 1,
}
]
},
}
Kode error
Jika error dikembalikan saat Anda 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. Periksa pesan error untuk detailnya. |
| 403 | forbidden.accessDenied | %s | Tidak ada izin. |
| 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Periksa apakah dokumen yang ingin Anda akses 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. Coba lagi nanti. |
| 500 | unknownError | Unknown Error | Error tidak diketahui. |
| 503 | operationTimeout | %s | Permintaan melebihi batas waktu. |