Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v2.0/doc/spaces/{spaceId}/pin |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permissions | permission-Document.Workspace.Write-Knowledge Base write permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an organization authorized to a third-party app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| spaceId | String | Yes | The knowledge base ID. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The operator’s UnionID. |
Request example
HTTPPOST /v2.0/doc/spaces/space_id/pin?operatorId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:222222xcdsdsda
Content-Type:application/json
// This file is auto-generated, don't edit it. Thanks.
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_2_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_2_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkdoc_2_0.Client client = Sample.createClient();
com.aliyun.dingtalkdoc_2_0.models.PinSpaceHeaders pinSpaceHeaders = new com.aliyun.dingtalkdoc_2_0.models.PinSpaceHeaders();
pinSpaceHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_2_0.models.PinSpaceRequest pinSpaceRequest = new com.aliyun.dingtalkdoc_2_0.models.PinSpaceRequest()
.setOperatorId("union_id");
try {
client.pinSpaceWithOptions("space_id", pinSpaceRequest, pinSpaceHeaders, 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 attributes that help locate 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 attributes that help locate the issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.doc_2_0.client import Client as dingtalkdoc_2_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_2_0 import models as dingtalkdoc__2__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_2_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_2_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
pin_space_headers = dingtalkdoc__2__0_models.PinSpaceHeaders()
pin_space_headers.x_acs_dingtalk_access_token = '<your access token>'
pin_space_request = dingtalkdoc__2__0_models.PinSpaceRequest(
operator_id='union_id'
)
try:
client.pin_space_with_options('space_id', pin_space_request, pin_space_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 attributes that help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
pin_space_headers = dingtalkdoc__2__0_models.PinSpaceHeaders()
pin_space_headers.x_acs_dingtalk_access_token = '<your access token>'
pin_space_request = dingtalkdoc__2__0_models.PinSpaceRequest(
operator_id='union_id'
)
try:
await client.pin_space_with_options_async('space_id', pin_space_request, pin_space_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 attributes that help locate the 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_2_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\PinSpaceHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_2_0\Models\PinSpaceRequest;
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();
$pinSpaceHeaders = new PinSpaceHeaders([]);
$pinSpaceHeaders->xAcsDingtalkAccessToken = "<your access token>";
$pinSpaceRequest = new PinSpaceRequest([
"operatorId" => "union_id"
]);
try {
$client->pinSpaceWithOptions("space_id", $pinSpaceRequest, $pinSpaceHeaders, 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 attributes that help locate 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));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"encoding/json"
"strings"
"fmt"
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkdoc_2_0 "github.com/alibabacloud-go/dingtalk/doc_2_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_2_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkdoc_2_0.Client{}
_result, _err = dingtalkdoc_2_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
pinSpaceHeaders := &dingtalkdoc_2_0.PinSpaceHeaders{}
pinSpaceHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
pinSpaceRequest := &dingtalkdoc_2_0.PinSpaceRequest{
OperatorId: tea.String("union_id"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.PinSpaceWithOptions(tea.String("space_id"), pinSpaceRequest, pinSpaceHeaders, &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 attributes that help locate the 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_2_0 = require('@alicloud/dingtalk/doc_2_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_2_0.default(config);
}
static async main(args) {
let client = Client.createClient();
let pinSpaceHeaders = new dingtalkdoc_2_0.PinSpaceHeaders({ });
pinSpaceHeaders.xAcsDingtalkAccessToken = '<your access token>';
let pinSpaceRequest = new dingtalkdoc_2_0.PinSpaceRequest({
operatorId: 'union_id',
});
try {
await client.pinSpaceWithOptions('space_id', pinSpaceRequest, pinSpaceHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err contains code and message attributes that help locate the issue
}
}
}
}
exports.Client = Client;
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
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_2_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkdoc_2_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkdoc_2_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceHeaders pinSpaceHeaders = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceHeaders();
pinSpaceHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceRequest pinSpaceRequest = new AlibabaCloud.SDK.Dingtalkdoc_2_0.Models.PinSpaceRequest
{
OperatorId = "union_id",
};
try
{
client.PinSpaceWithOptions("space_id", pinSpaceRequest, pinSpaceHeaders, 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 attributes that help locate 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 attributes that help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| success | Boolean | Whether the operation succeeded. |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Error codes
If an error occurs when calling this API, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | paramError | %s | Parameter error |
| 400 | paramError.spaceId | %s | Parameter error - spaceId |
| 403 | permissionDenied | The operator has no permission. | The current user does not have permission for this action |
| 404 | spaceNotExist | %s | The knowledge base does not exist |
| 500 | systemError | %s | The service is busy. Try again later |
| 500 | unknownError | Unknown Error | Unknown error |