Deskripsi panggilan API
Setiap operasi peserta mendukung hingga 500 orang, dan mendukung acara dengan hingga 5.000 peserta.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}/attendees |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga appType-Aplikasi personal pihak ketiga |
| Izin yang diperlukan | permission-Calendar.Event.Write-Izin tulis untuk acara di aplikasi Kalender |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-client-token | String | Tidak | Pemeriksaan idempotensi. - x-client-token yang sama menunjukkan permintaan yang sama. - Kedaluwarsa setelah 1 hari. |
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses untuk memanggil API ini. Dapatkan sebagai berikut: - Untuk aplikasi internal, panggil API Mendapatkan access token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Mendapatkan access token perusahaan yang memberi otorisasi ke aplikasi pihak ketiga. - Untuk aplikasi personal pihak ketiga, panggil API Mendapatkan user token. |
Parameter path
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| userId | String | Ya | unionId dari pembuat acara. - Untuk aplikasi internal atau aplikasi perusahaan pihak ketiga, panggil API Melihat detail pengguna untuk mendapatkan nilai parameter unionid. - Untuk aplikasi personal pihak ketiga, panggil API Mendapatkan profil pengguna dari kontak untuk mendapatkan nilai parameter unionId. |
| calendarId | String | Ya | ID kalender tempat acara berada. Setel ke primary untuk menunjukkan kalender utama pengguna. |
| eventId | String | Ya | ID acara. Panggil API Melihat daftar acara untuk mendapatkan nilai parameter id. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| attendeesToAdd | Array | Ya | Daftar peserta yang akan ditambahkan. |
| id | String | Tidak | unionId dari peserta. - Untuk aplikasi internal atau aplikasi perusahaan pihak ketiga, panggil API Melihat detail pengguna untuk mendapatkan nilai parameter unionid. - Untuk aplikasi personal pihak ketiga, panggil API Mendapatkan profil pengguna dari kontak untuk mendapatkan nilai parameter unionId. |
| isOptional | Boolean | Tidak | Menentukan apakah peserta bersifat opsional. - true: Ya. - false: Tidak. |
| pushNotification | Boolean | Tidak | Menentukan apakah akan mengirim pengingat pop-up. |
| chatNotification | Boolean | Tidak | Menentukan apakah akan mengirim pengingat pesan langsung. |
Contoh permintaan
HTTPPOST /v1.0/calendar/users/U5KPwll3QjgiG/calendars/primary/events/cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08/attendees HTTP/1.1
Host:api.dingtalk.io
x-client-token:******
x-acs-dingtalk-access-token:dd43888e26953deead8cba556389b063
Content-Type:application/json
{
"attendeesToAdd" : [ {
"id" : "iiiP35sJadba8aBSgjrwPRKgiEiF",
"isOptional" : false
} ]
}
// 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 with a Token
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkcalendar_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.dingtalkcalendar_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkcalendar_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeHeaders addAttendeeHeaders = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeHeaders();
addAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd attendeesToAdd0 = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd()
.setId("iiiP35sJadba8aBSgjrwPRKgiEiF")
.setIsOptional(false);
com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest addAttendeeRequest = new com.aliyun.dingtalkcalendar_1_0.models.AddAttendeeRequest()
.setAttendeesToAdd(java.util.Arrays.asList(
attendeesToAdd0
));
try {
client.addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, 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 mendiagnosis masalah
}
} 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 mendiagnosis masalah
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
from typing import List
from alibabacloud_dingtalk.calendar_1_0.client import Client as dingtalkcalendar_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.calendar_1_0 import models as dingtalkcalendar__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() -> dingtalkcalendar_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 dingtalkcalendar_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
add_attendee_headers = dingtalkcalendar__1__0_models.AddAttendeeHeaders()
add_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
attendees_to_add_0 = dingtalkcalendar__1__0_models.AddAttendeeRequestAttendeesToAdd(
id='iiiP35sJadba8aBSgjrwPRKgiEiF',
is_optional=False
)
add_attendee_request = dingtalkcalendar__1__0_models.AddAttendeeRequest(
attendees_to_add=[
attendees_to_add_0
]
)
try:
client.add_attendee_with_options('U5KPwll3QjgiG', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08', add_attendee_request, add_attendee_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 mendiagnosis masalah
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
add_attendee_headers = dingtalkcalendar__1__0_models.AddAttendeeHeaders()
add_attendee_headers.x_acs_dingtalk_access_token = '<your access token>'
attendees_to_add_0 = dingtalkcalendar__1__0_models.AddAttendeeRequestAttendeesToAdd(
id='iiiP35sJadba8aBSgjrwPRKgiEiF',
is_optional=False
)
add_attendee_request = dingtalkcalendar__1__0_models.AddAttendeeRequest(
attendees_to_add=[
attendees_to_add_0
]
)
try:
await client.add_attendee_with_options_async('U5KPwll3QjgiG', 'primary', 'cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08', add_attendee_request, add_attendee_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 mendiagnosis masalah
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\Vcalendar_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddAttendeeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddAttendeeRequest\attendeesToAdd;
use AlibabaCloud\SDK\Dingtalk\Vcalendar_1_0\Models\AddAttendeeRequest;
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();
$addAttendeeHeaders = new AddAttendeeHeaders([]);
$addAttendeeHeaders->xAcsDingtalkAccessToken = "<your access token>";
$attendeesToAdd0 = new attendeesToAdd([
"id" => "iiiP35sJadba8aBSgjrwPRKgiEiF",
"isOptional" => false
]);
$addAttendeeRequest = new AddAttendeeRequest([
"attendeesToAdd" => [
$attendeesToAdd0
]
]);
try {
$client->addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", $addAttendeeRequest, $addAttendeeHeaders, 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 mendiagnosis masalah
}
}
}
}
$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"
dingtalkcalendar_1_0 "github.com/alibabacloud-go/dingtalk/calendar_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Initialize the account Client with a Token
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkcalendar_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkcalendar_1_0.Client{}
_result, _err = dingtalkcalendar_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
addAttendeeHeaders := &dingtalkcalendar_1_0.AddAttendeeHeaders{}
addAttendeeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
attendeesToAdd0 := &dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd{
Id: tea.String("iiiP35sJadba8aBSgjrwPRKgiEiF"),
IsOptional: tea.Bool(false),
}
addAttendeeRequest := &dingtalkcalendar_1_0.AddAttendeeRequest{
AttendeesToAdd: []*dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd{attendeesToAdd0},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.AddAttendeeWithOptions(tea.String("U5KPwll3QjgiG"), tea.String("primary"), tea.String("cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08"), addAttendeeRequest, addAttendeeHeaders, &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 mendiagnosis masalah
}
}
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 dingtalkcalendar_1_0, * as $dingtalkcalendar_1_0 from '@alicloud/dingtalk/calendar_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 with a Token
* @return Client
* @throws Exception
*/
static createClient(): dingtalkcalendar_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkcalendar_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let addAttendeeHeaders = new $dingtalkcalendar_1_0.AddAttendeeHeaders({ });
addAttendeeHeaders.xAcsDingtalkAccessToken = "<your access token>";
let attendeesToAdd0 = new $dingtalkcalendar_1_0.AddAttendeeRequestAttendeesToAdd({
id: "iiiP35sJadba8aBSgjrwPRKgiEiF",
isOptional: false,
});
let addAttendeeRequest = new $dingtalkcalendar_1_0.AddAttendeeRequest({
attendeesToAdd: [
attendeesToAdd0
],
});
try {
await client.addAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err berisi atribut code dan message, yang membantu mendiagnosis masalah
}
}
}
}
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 with a Token
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeHeaders addAttendeeHeaders = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeHeaders();
addAttendeeHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd attendeesToAdd0 = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd
{
Id = "iiiP35sJadba8aBSgjrwPRKgiEiF",
IsOptional = false,
};
AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest addAttendeeRequest = new AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest
{
AttendeesToAdd = new List<AlibabaCloud.SDK.Dingtalkcalendar_1_0.Models.AddAttendeeRequest.AddAttendeeRequestAttendeesToAdd>
{
attendeesToAdd0
},
};
try
{
client.AddAttendeeWithOptions("U5KPwll3QjgiG", "primary", "cnNTbW1YbU9sL2p6aFJZdEgvdlQrQT08", addAttendeeRequest, addAttendeeHeaders, 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 mendiagnosis masalah
}
}
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 mendiagnosis masalah
}
}
}
}
}
Respons
Contoh isi respons
HTTP/1.1 200 OK
Kode error
Jika terjadi error saat memanggil API ini, temukan solusinya berdasarkan pesan error di dokumen Kode error global.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | invalidParameter | forwardErrorMessage | Parameter tidak valid. |
| 400 | idempotencyProcessing | Idempotency processing | Permintaan idempoten sedang diproses. |
| 404 | itemNotFound | forwardErrorMessage | Acara yang ditentukan tidak dapat ditemukan. |