Siirry sisältöön

Kalenteri

Aikataulusi, ajanvarausasivut ja palvelut.

Avaa Kalenteri
Tarkistettu koontinäyttöä vasten 19. marraskuuta 2026

Calendarilla on julkisia metodeja varauksen molemmille puolille. Jotkin toimivat puolestasi, omistajan, ja ottavat API-avaimesi: ne lukevat asetuksesi ja varauksesi, määrittävät resurssit, palvelut ja sivut, pidättävät ja vahvistavat ajan, peruvat ja vaihtavat paketin. Toiset ovat niitä, joita varaussivu kutsuu kävijälle. Ne eivät tarvitse avainta, vain sivun avaimen.

Kalenterien jakaminen muiden kanssa, näkymät, tehtävät, päivän tapahtumat ja Kalenterin asetukset tehdään hallintapaneelissa. Niillä ei ole tällä hetkellä julkista metodia.

Lähetä pyyntö metodille avaimellasi:

curl -s https://xuda.ai/cpi/get_calendar_setup \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","uid":"YOUR_ACCOUNT_UID"}'
const res = await fetch('https://xuda.ai/cpi/get_calendar_setup', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    uid: 'YOUR_ACCOUNT_UID',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_calendar_setup',
    json={
        'api_key': 'YOUR_API_KEY',
        'uid': 'YOUR_ACCOUNT_UID',
    },
)

Onnistuneen vastauksen code on 1. Muutos, jota pakettisi ei sisällä, hylätään koodilla code -62 ja lauseella kentässä data, esimerkiksi että ryhmätilaisuudet vaativat Growthin tai että pakettisi sisältää tietyn määrän varaussivuja. Jos haluat toimia kalenterilla tilistä, joka jakoi sen kanssasi muokkaustasolla, anna sen share_id metodeille, jotka sen ottavat.

Lue asetuksesi ja varauksesi

  • get_calendar_setup vastaa kaikkeen, mitä Calendar-näkymät piirtävät, yhdellä kutsulla: varattavat ihmiset ja huoneet aukioloaikoineen, palvelut ja julkaistut varaussivut julkisine osoitteineen.
  • get_calendar_bookings listaa varaukset, oletuksena tulevat. Anna past arvolla true jo tapahtuneille, uusin ensin, ja limit sille, kuinka monta. Jokaisella rivillä on aika resurssin vyöhykkeessä, vieraan tiedot ja kaikki, mitä hän sanoi varatessaan.
  • get_calendar_slots listaa yhden palvelun varattavat ajat yhdellä resurssilla välillä from_ts ja to_ts (epoch-millisekunteja), kaikki jo varatut jätettynä pois.

Määritä, mitä voi varata

  • save_calendar_resource tekee tai päivittää varattavan asian: henkilön, huoneen, tuolin tai laitteen. Se tarvitsee timezone-kentän, IANA-vyöhykkeen kuten Asia/Jerusalem, ja sen aukioloajat luetaan siinä vyöhykkeessä. Jätä resource_id pois tehdäksesi uuden.
  • save_calendar_service tekee tai päivittää sen, mitä ihmiset voivat varata: sen keston, puskurit, varoajan, kuinka pitkälle etukäteen se voidaan varata, paikat, missä se tapahtuu (meeting_kind) ja kentillä price_cents, currency ja checkout sen hinnan ja sen, maksetaanko se varattaessa. Useampi kuin yksi paikka vaatii paketin, joka sisältää ryhmätilaisuudet, ja maksun ottaminen vaatii paketin, joka sisältää maksut.
  • save_calendar_page tekee tai päivittää varaussivun: sen title, intro, tarjottavat service_ids, onko se enabled, sen accent-värin, sen bg_color ja text_color (kumpikin #rrggbb, tai tyhjä, jolloin sivu tekee sen korostusväristä), show_host, voivatko kävijät muuttaa varaustaan (visitor_changes, change_hours, refund_percent) ja Finance-tilin, jolle maksetaan (finance_account_id). Sivun tekeminen paketin sivurajan yli hylätään.
  • delete_calendar_item poistaa resurssin, palvelun tai sivun kentällä item_id. Varauksia ei koskaan poisteta näin: ne peruutetaan.

Varaa aika itse

Varaaminen omasta koodistasi on kaksi vaihetta, jotta samaa aikaa ei koskaan myydä kahdesti.

Pidätä aika

hold_calendar_slot varaa ajan muutamaksi minuutiksi. Anna resource_id, service_id ja start_utc (epoch-millisekunteja). Onnistuneen vastauksen data sisältää occ_id, hold_token ja expires_at. Lähetä idem_key, jotta kutsun toisto palauttaa saman pidätyksen toisen paikan ottamisen sijaan.

Vahvista se

confirm_calendar_booking muuttaa pidätyksen varaukseksi. Anna pidätyksen occ_id ja hold_token sekä vieraan name, email, phone ja note. Pidätys, jota ei enää ole, on menettänyt ajan ja hylätään.

curl -s https://xuda.ai/cpi/hold_calendar_slot \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","uid":"YOUR_ACCOUNT_UID","resource_id":"RESOURCE_ID","service_id":"SERVICE_ID","start_utc":1793000000000}'
const res = await fetch('https://xuda.ai/cpi/hold_calendar_slot', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    uid: 'YOUR_ACCOUNT_UID',
    resource_id: 'RESOURCE_ID',
    service_id: 'SERVICE_ID',
    start_utc: 1793000000000,
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/hold_calendar_slot',
    json={
        'api_key': 'YOUR_API_KEY',
        'uid': 'YOUR_ACCOUNT_UID',
        'resource_id': 'RESOURCE_ID',
        'service_id': 'SERVICE_ID',
        'start_utc': 1793000000000,
    },
)

Muuta varausta

  • cancel_calendar_booking peruu kentällä booking_id ja palauttaa ajan julkiseen ruudukkoon. Sen voi kutsua turvallisesti kahdesti. Se vain vapauttaa ajan: se ei lähetä vieraalle sähköpostia eikä palauta maksua, minkä hallintapaneelin Peruuta tapaaminen tekee vieraalle, joka varasi sivusi kautta.
  • notify_calendar_guests lähettää sähköpostin jokaiselle yhteen varaukseen kutsutulle, yksi viesti kullekin, kalenterikutsu liitteenä ja valinnainen message enintään 2000 merkkiä. kind on invite uudelle tapaamiselle ja update muutokselle, mikä on oletus. Sähköposti tulee omasta postilaatikostasi paketilla, joka sisältää sen, ja muuten Xudan varausosoitteesta, jolloin osoitteesi on vastausosoitteena.
  • create_booking_room tekee Xuda Meet -huoneen vahvistetulle videovaraukselle, jolla sitä ei ole, ja lähettää jokaiselle vieraalle linkin.

Mitä varaussivu kutsuu

Varaussivu toimii sivuavaimellaan <uid>.<page_id> ilman tiliä.

  • get_booking_bootstrap vastaa sen, mitä sivu tarvitsee piirtääkseen itsensä: sen otsikon, palvelut ja tuoreen bottien vastaisen tunnisteen.
  • get_public_booking_slots listaa ajat, joista kävijä voi valita, kullakin alku, loppu ja paikkamäärä. Se ei koskaan kerro, kuka pitää muita paikkoja.
  • public_book_slot ottaa varauksen kävijältä. Anna page_key, service_id, start_utc, token sekä kävijän name ja email. Lisää idem_key, jotta tuplapainallus ei varaa kahdesti. company_website on ansa boteille: jätä se tyhjäksi.
  • Palvelulle, joka maksetaan varattaessa, public_start_paid_booking pidättää ajan ja aloittaa maksun, start_booking_payment lähettää pidätetyn ajan Stripelle, ja public_confirm_paid_booking ja confirm_paid_booking varaavat sen, kun maksu on mennyt läpi. Maksu luetaan takaisin Stripestä ennen kuin mitään varataan.
  • Kävijä hallitsee varausta sähköpostissaan olevasta yksityisestä linkistä. get_public_booking, public_cancel_booking ja public_reschedule_booking ottavat sivuavaimen ja kyseisen linkin manage-arvon. Ne noudattavat sivun sääntöjä: saavatko kävijät muuttaa varausta ja kuinka monta tuntia ennen sen alkua. Maksettu varaus palautetaan ensin sivun palautusprosentin mukaan.

Paketti

get_calendar_plans vastaa neljä tasoa hintoineen ja sen, mitä kukin sisältää, mikä paketti sinulla on ja onko Calendar kytketty päälle. calendar_set_plan kytkee sen päälle, vaihtaa tasoa tai kytkee sen pois: anna plan_id arvona calendar_free, calendar_starter, calendar_growth tai calendar_business, tai aseta deactivate arvoon true. Katso Paketit ja laskutus.

Kaikki metodit

Millainen tämä opas on?

Päivitetty viimeksi 19. marraskuuta 2026