Hopp til innholdet

Kalender

Timeplanen din, bookingsider og tjenester.

Åpne Kalender
Kontrollert mot oversiktspanelet 19. november 2026

Calendar har offentlige metoder for de to sidene av en booking. Noen handler for deg, eieren, og tar API-nøkkelen din: de leser oppsettet og bookingene dine, setter opp ressurser, tjenester og sider, holder og bekrefter et tidspunkt, avbestiller og endrer planen. Andre er de en bookingside gjør for en besøkende. De trenger ingen nøkkel, bare sidens nøkkel.

Deling av kalendere med andre, visningene, oppgavene, dagshendelsene og Kalenderinnstillinger gjøres i dashbordet. De har ingen offentlig metode i dag.

Send en forespørsel til en metode med nøkkelen din:

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

Et godt svar har code 1. En endring planen din ikke inkluderer, avvises med code -62 og en setning i data, for eksempel at gruppetimer krever Growth eller at planen din rommer et visst antall bookingsider. For å handle på kalenderen til en konto som delte den med deg på redigeringsnivå, sender du share_id til metodene som tar en.

Les oppsettet og bookingene dine

  • get_calendar_setup svarer med alt Kalender-skjermbildene tegner i ett kall: personene og rommene som kan bookes, med åpningstidene sine, tjenestene og de publiserte bookingsidene med sine offentlige adresser.
  • get_calendar_bookings lister bookinger, kommende som standard. Send past satt til true for de som allerede har skjedd, nyeste først, og limit for hvor mange. Hver rad har tidspunktet i ressursens sone, gjestens opplysninger og alt de sa da de booket.
  • get_calendar_slots lister de bookbare tidspunktene for én tjeneste på én ressurs mellom from_ts og to_ts (epoch-millisekunder), uten alt som allerede er tatt.

Sett opp hva som kan bookes

  • save_calendar_resource lager eller oppdaterer noe som kan bookes: en person, et rom, en stol eller en enhet. Den trenger en timezone, en IANA-sone som Asia/Jerusalem, og åpningstidene leses i den sonen. Utelat resource_id for å lage en ny.
  • save_calendar_service lager eller oppdaterer det folk kan booke: lengden, buffere, varsel, hvor langt fram den kan bookes, plasser, hvor den møtes (meeting_kind), og, med price_cents, currency og checkout, hva den koster og om den betales ved booking. Mer enn én plass krever en plan som inkluderer gruppetimer, og å ta betaling krever en plan som inkluderer betalinger.
  • save_calendar_page lager eller oppdaterer en bookingside: title, intro, service_ids den tilbyr, om den er enabled, aksentfargen accent, bg_color og text_color (hver #rrggbb, eller tom for at siden lager den fra aksenten), show_host, om besøkende kan endre bookingen sin (visitor_changes, change_hours, refund_percent) og finanskontoen den betales inn på (finance_account_id). Å lage en side over planens sidegrense avvises.
  • delete_calendar_item fjerner en ressurs, en tjeneste eller en side med item_id. Bookinger slettes aldri på denne måten: de avbestilles.

Book et tidspunkt selv

Å booke fra din egen kode er to steg, så ett tidspunkt aldri selges to ganger.

Hold tidspunktet

hold_calendar_slot reserverer et tidspunkt i noen minutter. Send resource_id, service_id og start_utc (epoch-millisekunder). Et godt svar har data med occ_id, hold_token og expires_at. Send en idem_key så en gjentakelse av kallet returnerer samme hold i stedet for å ta en ny plass.

Bekreft det

confirm_calendar_booking gjør holdet om til en booking. Send occ_id og hold_token fra holdet, og gjestens name, email, phone og note. Et hold som ikke finnes lenger, har mistet tidspunktet og avvises.

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

Endre en booking

  • cancel_calendar_booking avbestiller med booking_id og legger tiden tilbake på det offentlige rutenettet. Det er trygt å kalle to ganger. Den frigir bare tiden: den sender ikke e-post til gjesten og refunderer ingen betaling, noe Avbestill avtalen i dashbordet gjør for en gjest som booket gjennom siden din.
  • notify_calendar_guests sender e-post til alle som er invitert til én booking, én melding hver, med kalenderinvitasjonen vedlagt og en valgfri message på opptil 2000 tegn. kind er invite for en ny avtale og update for en endring, som er standard. E-posten kommer fra din egen postboks på en plan som inkluderer det, og ellers fra Xudas bookingadresse, med adressen din som svaradresse.
  • create_booking_room lager Xuda Meet-rommet til en bekreftet videobooking som ikke har noe, og sender hver gjest lenken.

Hva en bookingside kaller

En bookingside virker med sidenøkkelen sin, <uid>.<page_id>, og ingen konto.

  • get_booking_bootstrap svarer med det en side trenger for å tegne seg selv: tittelen, tjenestene og et ferskt anti-bot-token.
  • get_public_booking_slots lister tidspunktene en besøkende kan velge, hvert med en start, en slutt og et antall plasser. Den sier aldri hvem som har de andre plassene.
  • public_book_slot tar imot en booking fra en besøkende. Send page_key, service_id, start_utc, token og den besøkendes name og email. Legg til en idem_key så et dobbelt trykk ikke booker to ganger. company_website er en felle for roboter: la den stå tom.
  • For en tjeneste som betales ved booking holder public_start_paid_booking tidspunktet og starter betalingen, start_booking_payment sender et holdt tidspunkt til Stripe, og public_confirm_paid_booking og confirm_paid_booking booker det når betalingen er gjennomført. Betalingen leses tilbake fra Stripe før noe bookes.
  • En besøkende styrer en booking fra den private lenken i e-posten sin. get_public_booking, public_cancel_booking og public_reschedule_booking tar sidenøkkelen og lenkens manage-verdi. De følger sidens regler: om besøkende kan endre en booking, og opptil hvor mange timer før den starter. En betalt booking refunderes først, med sidens refusjonsprosent.

Planen

get_calendar_plans svarer med de fire nivåene med priser og hva hvert har, hvilken plan du er på og om Calendar er slått på. calendar_set_plan slår det på, endrer nivået eller slår det av: send plan_id som calendar_free, calendar_starter, calendar_growth eller calendar_business, eller sett deactivate til true. Se Planer og fakturering.

Alle metodene

Hvordan er denne veiledningen?

Sist oppdatert 19. november 2026