Pesan Slot
Pesan Slot
Buat slot tidak tersedia untuk dipesan oleh orang lain selama jangka waktu tertentu. Jika Anda mengautentikasi menggunakan kredensial OAuth, kunci API, atau token akses, Anda juga dapat menentukan durasi kustom berapa lama slot harus dipesan (default 5 menit).
Pastikan untuk menyertakan nilai header cal-api-version seperti yang disebutkan di bagian Header. Jika tidak menyertakan nilai yang benar, endpoint akan menggunakan versi lama.
Permintaan (cURL)
curl --request POST \
--url cal \
--header 'Content-Type: application/json' \
--header 'cal-api-version: <cal-api-version>' \
--data '
{
"eventTypeId": 1,
"slotStart": "2024-09-04T09:00:00Z",
"slotDuration": 30,
"reservationDuration": 5
}'Respons (201)
{
"status": "success",
"data": {
"eventTypeId": 1,
"slotStart": "2024-09-04T09:00:00Z",
"slotEnd": "2024-09-04T10:00:00Z",
"slotDuration": 30,
"reservationUid": "e84be5a3-4696-49e3-acc7-b2f3999c3b94",
"reservationDuration": 5,
"reservationUntil": "2023-09-04T10:00:00Z"
}
}Header
| Parameter | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| cal-api-version | string | Harus disetel ke 2024-09-04. Jika tidak, endpoint akan menggunakan versi lama. | Ya |
| Authorization | string | Nilai harus Bearer <token> di mana token adalah kunci API dengan awalan cal_, token akses pengguna terkelola, atau token akses OAuth. | Ya |
| x-cal-client-id | string | Untuk pelanggan platform - ID klien OAuth | Tidak |
Badan Permintaan
| Parameter | Tipe | Deskripsi | Wajib |
|---|---|---|---|
| eventTypeId | number | ID tipe acara yang slotnya akan dipesan. Contoh: 1 | Ya |
| slotStart | string (date-time) | String tanggal ISO 8601 dalam zona waktu UTC yang mewakili slot tersedia. Contoh: "2024-09-04T09:00:00Z" | Ya |
| slotDuration | number | Secara default durasi slot sama dengan panjang tipe acara, tetapi jika Anda ingin memesan slot untuk tipe acara yang memiliki panjang variabel, Anda dapat menentukannya di sini dalam menit. Jika tidak diatur secara eksplisit, tipe acara dapat memiliki salah satu dari banyak panjang. Contoh: 30 | Tidak |
| reservationDuration | number | HANYA untuk permintaan yang diautentikasi dengan kunci API, token akses, atau kredensial OAuth (ID + rahasia). Untuk berapa menit slot harus dipesan - selama waktu ini tidak ada orang lain yang dapat memesan tipe acara ini pada waktu mulai. Jika tidak disediakan, default ke 5 menit. Contoh: 5 | Tidak |
Respons
| Bidang | Tipe | Deskripsi |
|---|---|---|
| status | enum (string) | Wajib. Opsi: success, error. Contoh: "success" |
| data | object | Wajib. Berisi: eventTypeId (number), slotStart (string), slotEnd (string), slotDuration (number), reservationUid (string), reservationDuration (number), reservationUntil (string). Lihat contoh respons. |