PartyInformation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-party-information-schema.json",
  "title": "PartyInformation",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-call-controls-api-openapi.yml#/components/schemas/PartyInformation",
  "type": "object",
  "required": [
    "privacyEnabled",
    "callType"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The party's name. Only present when the name is available and privacy is not enabled."
    },
    "number": {
      "type": "string",
      "description": "The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: `1234`, `2223334444`, `+12223334444`, `*73`, `user@company.domain`"
    },
    "personId": {
      "type": "string",
      "description": "The party's person ID. Only present when the person ID is available and privacy is not enabled."
    },
    "placeId": {
      "type": "string",
      "description": "The party's place ID. Only present when the place ID is available and privacy is not enabled."
    },
    "privacyEnabled": {
      "type": "boolean",
      "description": "Indicates whether privacy is enabled for the name, number and personId/placeId."
    },
    "callType": {
      "allOf": [
        {
          "$ref": "#/$defs/CallTypeEnum"
        }
      ],
      "description": "The call type for the party."
    }
  },
  "$defs": {
    "CallTypeEnum": {
      "type": "string",
      "enum": [
        "location",
        "organization",
        "external",
        "emergency",
        "repair",
        "other"
      ],
      "description": " * `location` - The party is within the same location.\n * `organization` - The party is within the same organization but not within the same location.\n * `external` - The party is outside the organization.\n * `emergency` - The party is an emergency call destination.\n * `repair` - The party is a repair call destination.\n * `other` - The party does not belong to one of the defined call types. For example, a call to a Call Forwarding Always feature activation code.\n"
    }
  }
}