Deskripsi panggilan API
- Di Developer Backend, buka App Event Subscription lalu aktifkan langganan peristiwa storage.
- Panggil API ini untuk menetapkan cakupan langganan sebagai organisasi atau ruang penyimpanan tertentu.
Catatan
Mengaktifkan tombol langganan peristiwa storage di Developer Backend saja tidak cukup untuk menerima peristiwa callback. Anda juga harus memanggil API ini.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/storage/events/subscribe |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Storage.Event.Write-Izin tulis untuk langganan peristiwa perubahan file storage organisasi |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan dengan cara berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token organisasi yang diberi otorisasi untuk aplikasi pihak ketiga. |
Parameter kueri
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| unionId | String | Ya | unionId operator. Panggil API Mengueri detail pengguna untuk mendapatkannya. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| scopeId | String | Ya | ID yang sesuai dengan cakupan langganan. - Ketika nilai parameter scope adalah ORG, scopeId sesuai dengan ID organisasi (corpId). Lihat Konsep dasar - CorpId. - Ketika scope adalah SPACE, scopeId sesuai dengan ID ruang penyimpanan. Panggil API Menambahkan ruang untuk mendapatkan id. |
| scope | String | Ya | Cakupan langganan. - ORG: organisasi - SPACE: ruang |
Contoh permintaan
HTTPPOST /v1.0/storage/events/subscribe?unionId=union_id HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"scopeId" : "SPACE",
"scope" : "SPACE"
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkstorage_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.dingtalkstorage_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkstorage_1_0.models.SubscribeEventHeaders subscribeEventHeaders = new com.aliyun.dingtalkstorage_1_0.models.SubscribeEventHeaders();
subscribeEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.SubscribeEventRequest subscribeEventRequest = new com.aliyun.dingtalkstorage_1_0.models.SubscribeEventRequest()
.setUnionId("union_id")
.setScopeId("SPACE")
.setScope("SPACE");
try {
client.subscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, 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 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 issue
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__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() -> dingtalkstorage_1_0Client:
"""
Initialize the account Client using a Token
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkstorage_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
subscribe_event_headers = dingtalkstorage__1__0_models.SubscribeEventHeaders()
subscribe_event_headers.x_acs_dingtalk_access_token = '<your access token>'
subscribe_event_request = dingtalkstorage__1__0_models.SubscribeEventRequest(
union_id='union_id',
scope_id='SPACE',
scope='SPACE'
)
try:
client.subscribe_event_with_options(subscribe_event_request, subscribe_event_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 issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
subscribe_event_headers = dingtalkstorage__1__0_models.SubscribeEventHeaders()
subscribe_event_headers.x_acs_dingtalk_access_token = '<your access token>'
subscribe_event_request = dingtalkstorage__1__0_models.SubscribeEventRequest(
union_id='union_id',
scope_id='SPACE',
scope='SPACE'
)
try:
await client.subscribe_event_with_options_async(subscribe_event_request, subscribe_event_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 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\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\SubscribeEventHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\SubscribeEventRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client using 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();
$subscribeEventHeaders = new SubscribeEventHeaders([]);
$subscribeEventHeaders->xAcsDingtalkAccessToken = "<your access token>";
$subscribeEventRequest = new SubscribeEventRequest([
"unionId" => "union_id",
"scopeId" => "SPACE",
"scope" => "SPACE"
]);
try {
$client->subscribeEventWithOptions($subscribeEventRequest, $subscribeEventHeaders, 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 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 (
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkstorage_1_0 "github.com/alibabacloud-go/dingtalk/storage_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkstorage_1_0.Client{}
_result, _err = dingtalkstorage_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
subscribeEventHeaders := &dingtalkstorage_1_0.SubscribeEventHeaders{}
subscribeEventHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
subscribeEventRequest := &dingtalkstorage_1_0.SubscribeEventRequest{
UnionId: tea.String("union_id"),
ScopeId: tea.String("SPACE"),
Scope: tea.String("SPACE"),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SubscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, &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 issue
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkstorage_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkstorage_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let subscribeEventHeaders = new $dingtalkstorage_1_0.SubscribeEventHeaders({ });
subscribeEventHeaders.xAcsDingtalkAccessToken = "<your access token>";
let subscribeEventRequest = new $dingtalkstorage_1_0.SubscribeEventRequest({
unionId: "union_id",
scopeId: "SPACE",
scope: "SPACE",
});
try {
await client.subscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message yang membantu menemukan issue
}
}
}
}
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
{
/**
* Initialize the account Client using a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventHeaders subscribeEventHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventHeaders();
subscribeEventHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventRequest subscribeEventRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.SubscribeEventRequest
{
UnionId = "union_id",
ScopeId = "SPACE",
Scope = "SPACE",
};
try
{
client.SubscribeEventWithOptions(subscribeEventRequest, subscribeEventHeaders, 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 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 issue
}
}
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| success | Boolean | Apakah operasi berhasil. true menunjukkan berhasil. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, cari solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | paramError | %s | Error parameter |
| 400 | paramError.scope | %s | Error parameter - scope |
| 400 | paramError.scopeId | %s | Error parameter - scopeId |
| 403 | permissionDenied | %s | Pengguna tidak memiliki izin untuk berlangganan peristiwa |
| 500 | systemError | %s | Error sistem |
| 500 | unknownError | Unknown Error | Error tidak diketahui |
| 503 | operationTimeout | %s | Permintaan melebihi batas waktu |