Ugrás a tartalomhoz

Naptár

Az Ön menetrendje, foglalási oldalak és szolgáltatások.

Naptár megnyitása
Az irányítópulttal összevetve ekkor: 2026. november 19.

A Calendar-nek nyilvános metódusai vannak a foglalás két oldalához. Egyesek Ön, a tulajdonos helyett járnak el, és az API-kulcsát kérik: olvassák a beállításait és a foglalásait, beállítják az erőforrásokat, szolgáltatásokat és oldalakat, visszatartanak és megerősítenek egy időpontot, lemondanak, és csomagot váltanak. A többi azok, amelyeket egy foglalási oldal indít egy látogatóért. Nekik nem kell kulcs, csak az oldal kulcsa.

A naptárak megosztása más emberekkel, a nézetek, a feladatok, a napi események és a Naptár beállításai a vezérlőpulton történnek. Ezekhez ma nincs nyilvános metódus.

Küldjön kérést egy metódusnak a kulcsával:

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',
    },
)

A jó válasz code értéke 1. Az olyan módosítást, amelyet a csomagja nem tartalmaz, code -62 értékkel és egy mondattal utasítjuk el a data-ban, például hogy a csoportos alkalmakhoz Growth kell, vagy hogy a csomagja egy meghatározott számú foglalási oldalt tartalmaz. Ha olyan fiók naptárán szeretne eljárni, amely szerkesztési szinten megosztotta Önnel, adja meg a share_id-ját azoknak a metódusoknak, amelyek kérnek ilyet.

Olvassa a beállításait és foglalásait

  • A get_calendar_setup egy hívásban megválaszol mindent, amit a Calendar képernyői megrajzolnak: a lefoglalható személyeket és termeket az óráikkal, a szolgáltatásokat, és a közzétett foglalási oldalakat a nyilvános címeikkel.
  • A get_calendar_bookings listázza a foglalásokat, alapértelmezés szerint a közelgőket. Adja meg a past értékét true-ra a már megtörténtekhez, legújabbal kezdve, és a limit értékét a darabszámhoz. Minden sor hordozza az időt az erőforrás zónájában, a vendég adatait és mindent, amit a foglaláskor mondott.
  • A get_calendar_slots listázza egy szolgáltatás lefoglalható időpontjait egy erőforráson a from_ts és a to_ts között (epoch ezredmásodperc), minden már foglaltat kihagyva.

Állítsa be, mi foglalható

  • A save_calendar_resource létrehoz vagy frissít valamit, ami lefoglalható: egy személyt, egy termet, egy széket vagy egy eszközt. Kell hozzá timezone, egy IANA zóna, például Asia/Jerusalem, és az óráit ebben a zónában olvassuk. A resource_id kihagyásával újat hoz létre.
  • A save_calendar_service létrehoz vagy frissít valamit, amit lefoglalhatnak: a hosszát, a pufferidőket, az előzetes értesítést, hogy mennyire előre foglalható, a helyeket, hol találkoznak (meeting_kind), és a price_cents, currency és checkout értékekkel azt, mibe kerül, és hogy foglaláskor fizetendő-e. Egynél több helyhez olyan csomag kell, amely tartalmazza a csoportos alkalmakat, a fizetés fogadásához pedig olyan, amely tartalmazza a fizetéseket.
  • A save_calendar_page létrehoz vagy frissít egy foglalási oldalt: a title értékét, az intro értékét, az általa kínált service_ids értékeket, hogy enabled-e, a accent színét, a bg_color és text_color értékét (mindegyik #rrggbb, vagy üres, hogy az oldal a kiemelő színből készítse), a show_host értéket, hogy a látogatók módosíthatják-e a foglalásukat (visitor_changes, change_hours, refund_percent), és a pénzügyi fiókot, amelyre a fizetést kapja (finance_account_id). A csomagja oldalkorlátján túli oldal létrehozását elutasítjuk.
  • A delete_calendar_item eltávolít egy erőforrást, egy szolgáltatást vagy egy oldalt az item_id alapján. A foglalásokat soha nem így töröljük: lemondják őket.

Foglaljon időpontot saját kezűleg

A saját kódjából való foglalás két lépés, így egy időpontot soha nem adnak el kétszer.

Tartsa vissza az időpontot

A hold_calendar_slot néhány percre lefoglal egy időpontot. Adja meg a resource_id, service_id és start_utc értékeket (epoch ezredmásodperc). A jó válasz data mezője tartalmazza az occ_id, hold_token és expires_at értékeket. Küldjön egy idem_key értéket, hogy a hívás ismétlése ugyanazt a visszatartást adja vissza ahelyett, hogy második helyet foglalna.

Erősítse meg

A confirm_calendar_booking a visszatartást foglalássá alakítja. Adja meg a visszatartásból származó occ_id és hold_token értékeket, és a vendég name, email, phone és note értékét. Azt a visszatartást, amely már nincs meg, elvesztette az időpontot, és elutasítjuk.

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,
    },
)

Módosítson egy foglalást

  • A cancel_calendar_booking a booking_id alapján mond le, és visszateszi az időt a nyilvános rácsra. Kétszer is biztonságosan meghívható. Csak az időt szabadítja fel: nem küld e-mailt a vendégnek, és nem térít vissza fizetést, amit a vezérlőpult Időpont lemondása megtesz az olyan vendégnél, aki az Ön oldalán keresztül foglalt.
  • A notify_calendar_guests e-mailt küld mindenkinek, akit egy foglalásra meghívtak, egyenként egy üzenetet, a naptármeghívó mellékletével és egy opcionális, legfeljebb 2000 karakteres message értékkel. A kind értéke invite egy új időponthoz és update egy módosításhoz, ez az alapértelmezett. Az e-mail az Ön saját postafiókjából érkezik azon a csomagon, amely tartalmazza, egyébként a Xuda foglalási címéről, az Ön címével válaszcímként.
  • A create_booking_room létrehozza a megerősített videófoglalás Xuda Meet szobáját, amelynek még nincs, és elküldi minden vendégnek a hivatkozást.

Mit hív meg egy foglalási oldal

A foglalási oldal az oldalkulcsával működik, <uid>.<page_id>, fiók nélkül.

  • A get_booking_bootstrap megválaszol mindent, amire egy oldalnak szüksége van, hogy megrajzolja magát: a címét, a szolgáltatásait és egy friss bot elleni tokent.
  • A get_public_booking_slots listázza azokat az időpontokat, amelyeket a látogató választhat, mindegyiket kezdettel, véggel és helyszámmal. Soha nem mondja meg, ki tartja a többi helyet.
  • A public_book_slot foglalást fogad el egy látogatótól. Adja meg a page_key, service_id, start_utc, token értékeket, és a látogató name és email értékét. Adjon hozzá egy idem_key értéket, hogy a dupla megnyomás ne foglaljon kétszer. A company_website egy csapda a botoknak: hagyja üresen.
  • A foglaláskor fizetendő szolgáltatáshoz a public_start_paid_booking visszatartja az időpontot és elindítja a fizetést, a start_booking_payment a visszatartott időpontot a Stripe-nak küldi, a public_confirm_paid_booking és a confirm_paid_booking pedig lefoglalja, miután a fizetés elszámolódott. A fizetést a Stripe-ból olvassuk vissza, mielőtt bármit lefoglalnánk.
  • A látogató az e-mailjében lévő privát hivatkozásról kezeli a foglalást. A get_public_booking, a public_cancel_booking és a public_reschedule_booking az oldalkulcsot és annak a hivatkozásnak a manage értékét kéri. Az oldal szabályait követik: módosíthatják-e a látogatók a foglalást, és legfeljebb hány órával a kezdete előtt. A fizetett foglalást előbb visszatérítik, az oldal visszatérítési százalékával.

A csomag

A get_calendar_plans megválaszolja a négy szintet az áraikkal és azzal, mit tartalmaz mindegyik, melyik csomagon van, és hogy a Calendar be van-e kapcsolva. A calendar_set_plan bekapcsolja, szintet vált, vagy kikapcsolja: adja meg a plan_id értékét calendar_free, calendar_starter, calendar_growth vagy calendar_business értékkel, vagy állítsa a deactivate értékét true-ra. Lásd: Csomagok és számlázás.

Az összes metódus

Milyen ez az útmutató?

Utoljára frissítve: 2026. november 20.