create_appointment_type

Diese Referenz wird aus dem veröffentlichten Werkzeugvertrag erzeugt. Feldnamen und normative Beschreibungen im Schema sind Englisch.

Verhalten und Grenzen

Legt eine neue Terminart (eine Buchungsseite) als Entwurf an, z. B. „Leg ein 30-minütiges Erstgespräch per Zoom an“. Sie nutzt die verbundenen Kalender und die Arbeitszeiten, wie eine neue Terminart in Ridian. Entwürfe sind nicht buchbar: Der Nutzer aktiviert sie nach dem Prüfen in Ridian unter console_url. Liefert die geplante URL der Buchungsseite, die erst mit der Aktivierung funktioniert; sie ist null, solange der Workspace keinen öffentlichen Namen hat. Titel, Dauer und Ort vorher mit dem Nutzer abstimmen.

Berechtigungen

Freigegebene Scopes, Konten, Kalender und Sichtbarkeitsregeln begrenzen den Zugriff. Ein Workspace-Admin erhält dadurch keinen pauschalen Zugriff auf fremde Konten.

bookings:write

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "Name bookers see, e.g. \"Intro call\"."
    },
    "description": {
      "description": "Shown on the booking page.",
      "type": "string",
      "maxLength": 5000
    },
    "duration_minutes": {
      "description": "Default 30.",
      "type": "integer",
      "minimum": 5,
      "maximum": 720
    },
    "location": {
      "description": "Default none. google_meet needs a Google calendar, microsoft_teams a Microsoft calendar, zoom a Zoom connection in Ridian.",
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "none",
            "address",
            "phone",
            "link",
            "google_meet",
            "microsoft_teams",
            "zoom"
          ]
        },
        "value": {
          "description": "Required for address, phone and link (https).",
          "type": "string",
          "maxLength": 500
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    },
    "questions": {
      "description": "Extra booking form questions. Name and email are always asked.",
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "type": {
            "type": "string",
            "enum": [
              "text",
              "multiline",
              "phone",
              "choice"
            ]
          },
          "required": {
            "type": "boolean"
          },
          "options": {
            "description": "Only for choice.",
            "minItems": 1,
            "maxItems": 30,
            "type": "array",
            "items": {
              "type": "string",
              "minLength": 1,
              "maxLength": 200
            }
          }
        },
        "required": [
          "label",
          "type",
          "required"
        ],
        "additionalProperties": false
      }
    },
    "confirmation": {
      "description": "manual: the host accepts each request first. Default instant.",
      "type": "string",
      "enum": [
        "instant",
        "manual"
      ]
    }
  },
  "required": [
    "title"
  ],
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "appointment_type": {
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "console_url": {
      "type": "string"
    },
    "next_step": {
      "type": "string"
    }
  },
  "required": [
    "appointment_type",
    "console_url",
    "next_step"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den aktuellen Ressourcen- oder Sendestatus.

Fehlerbehandlung