Naptár
Az Ön menetrendje, foglalási oldalak és szolgáltatások.
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:
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_setupegy 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_bookingslistázza a foglalásokat, alapértelmezés szerint a közelgőket. Adja meg apastértékéttrue-ra a már megtörténtekhez, legújabbal kezdve, és alimité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_slotslistázza egy szolgáltatás lefoglalható időpontjait egy erőforráson afrom_tsés ato_tsközött (epoch ezredmásodperc), minden már foglaltat kihagyva.
Állítsa be, mi foglalható
- A
save_calendar_resourcelé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áulAsia/Jerusalem, és az óráit ebben a zónában olvassuk. Aresource_idkihagyásával újat hoz létre. - A
save_calendar_servicelé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 aprice_cents,currencyéscheckouté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_pagelétrehoz vagy frissít egy foglalási oldalt: atitleértékét, azintroértékét, az általa kínáltservice_idsértékeket, hogyenabled-e, aaccentszínét, abg_coloréstext_colorértékét (mindegyik#rrggbb, vagy üres, hogy az oldal a kiemelő színből készítse), ashow_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_itemeltávolít egy erőforrást, egy szolgáltatást vagy egy oldalt azitem_idalapjá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.
Módosítson egy foglalást
- A
cancel_calendar_bookingabooking_idalapjá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_guestse-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 karakteresmessageértékkel. Akindértékeinviteegy új időponthoz ésupdateegy 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_roomlé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_bootstrapmegvá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_slotslistá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_slotfoglalást fogad el egy látogatótól. Adja meg apage_key,service_id,start_utc,tokenértékeket, és a látogatónameésemailértékét. Adjon hozzá egyidem_keyértéket, hogy a dupla megnyomás ne foglaljon kétszer. Acompany_websiteegy csapda a botoknak: hagyja üresen. - A foglaláskor fizetendő szolgáltatáshoz a
public_start_paid_bookingvisszatartja az időpontot és elindítja a fizetést, astart_booking_paymenta visszatartott időpontot a Stripe-nak küldi, apublic_confirm_paid_bookingés aconfirm_paid_bookingpedig 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, apublic_cancel_bookingés apublic_reschedule_bookingaz oldalkulcsot és annak a hivatkozásnak amanageé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.